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/mfib/mfib_table.h>
47 #include <vnet/dpo/drop_dpo.h>
48 #include <vnet/dpo/classify_dpo.h>
49 #include <vnet/dpo/punt_dpo.h>
50 #include <vnet/dpo/receive_dpo.h>
51 #include <vnet/dpo/ip_null_dpo.h>
52 #include <vnet/ip/ip6_neighbor.h>
56 * @brief IPv4 and IPv6 adjacency and lookup table managment.
61 ip_interface_address_add_del (ip_lookup_main_t * lm,
65 u32 is_del, u32 * result_if_address_index)
67 vnet_main_t *vnm = vnet_get_main ();
68 ip_interface_address_t *a, *prev, *next;
69 uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
71 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
73 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
75 /* Verify given length. */
76 if ((a && (address_length != a->address_length)) ||
77 (address_length == 0) ||
78 (lm->is_ip6 && address_length > 128) ||
79 (!lm->is_ip6 && address_length > 32))
81 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
82 return clib_error_create
83 ("%U wrong length (expected %d) for interface %U",
84 lm->format_address_and_length, addr_fib,
85 address_length, a ? a->address_length : -1,
86 format_vnet_sw_if_index_name, vnm, sw_if_index);
93 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
94 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
95 return clib_error_create ("%U not found for interface %U",
96 lm->format_address_and_length,
97 addr_fib, address_length,
98 format_vnet_sw_interface_name, vnm, si);
101 if (a->prev_this_sw_interface != ~0)
104 pool_elt_at_index (lm->if_address_pool,
105 a->prev_this_sw_interface);
106 prev->next_this_sw_interface = a->next_this_sw_interface;
108 if (a->next_this_sw_interface != ~0)
111 pool_elt_at_index (lm->if_address_pool,
112 a->next_this_sw_interface);
113 next->prev_this_sw_interface = a->prev_this_sw_interface;
115 if (a->prev_this_sw_interface == ~0)
116 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
117 a->next_this_sw_interface;
120 if ((a->next_this_sw_interface == ~0)
121 && (a->prev_this_sw_interface == ~0))
122 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
124 mhash_unset (&lm->address_to_if_address_index, addr_fib,
126 pool_put (lm->if_address_pool, a);
128 if (result_if_address_index)
129 *result_if_address_index = ~0;
134 u32 pi; /* previous index */
136 u32 hi; /* head index */
138 pool_get (lm->if_address_pool, a);
139 memset (a, ~0, sizeof (a[0]));
140 ai = a - lm->if_address_pool;
142 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
144 while (pi != (u32) ~ 0)
146 prev = pool_elt_at_index (lm->if_address_pool, pi);
147 pi = prev->next_this_sw_interface;
149 pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
151 a->address_key = mhash_set (&lm->address_to_if_address_index,
152 addr_fib, ai, /* old_value */ 0);
153 a->address_length = address_length;
154 a->sw_if_index = sw_if_index;
156 a->prev_this_sw_interface = pi;
157 a->next_this_sw_interface = ~0;
159 prev->next_this_sw_interface = ai;
161 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
162 (hi != ~0) ? hi : ai;
163 if (result_if_address_index)
164 *result_if_address_index = ai;
168 if (result_if_address_index)
169 *result_if_address_index = a - lm->if_address_pool;
173 return /* no error */ 0;
176 static clib_error_t *
177 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
179 vec_validate_init_empty (ip4_main.
180 lookup_main.if_address_pool_index_by_sw_if_index,
182 vec_validate_init_empty (ip6_main.
183 lookup_main.if_address_pool_index_by_sw_if_index,
189 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
192 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
194 if (!lm->fib_result_n_bytes)
195 lm->fib_result_n_bytes = sizeof (uword);
200 lm->format_address_and_length = format_ip6_address_and_length;
201 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
202 sizeof (ip6_address_fib_t));
206 lm->format_address_and_length = format_ip4_address_and_length;
207 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
208 sizeof (ip4_address_fib_t));
214 /* Setup all IP protocols to be punted and builtin-unknown. */
215 for (i = 0; i < 256; i++)
217 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
218 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
221 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
222 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
223 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
224 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
225 IP_BUILTIN_PROTOCOL_UDP;
226 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
228 IP_BUILTIN_PROTOCOL_ICMP;
233 format_ip_flow_hash_config (u8 * s, va_list * args)
235 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
237 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
238 foreach_flow_hash_bit;
245 format_ip_lookup_next (u8 * s, va_list * args)
247 /* int promotion of ip_lookup_next_t */
248 ip_lookup_next_t n = va_arg (*args, int);
254 s = format (s, "unknown %d", n);
257 case IP_LOOKUP_NEXT_DROP:
260 case IP_LOOKUP_NEXT_PUNT:
263 case IP_LOOKUP_NEXT_ARP:
266 case IP_LOOKUP_NEXT_MIDCHAIN:
269 case IP_LOOKUP_NEXT_GLEAN:
272 case IP_LOOKUP_NEXT_MCAST:
275 case IP_LOOKUP_NEXT_REWRITE:
280 vec_add (s, t, strlen (t));
286 format_ip_adjacency_packet_data (u8 * s, va_list * args)
288 u32 adj_index = va_arg (*args, u32);
289 u8 *packet_data = va_arg (*args, u8 *);
290 u32 n_packet_data_bytes = va_arg (*args, u32);
291 ip_adjacency_t *adj = adj_get (adj_index);
293 switch (adj->lookup_next_index)
295 case IP_LOOKUP_NEXT_REWRITE:
296 case IP_LOOKUP_NEXT_MCAST:
298 format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
309 unformat_dpo (unformat_input_t * input, va_list * args)
311 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
312 fib_protocol_t fp = va_arg (*args, int);
315 proto = fib_proto_to_dpo (fp);
317 if (unformat (input, "drop"))
318 dpo_copy (dpo, drop_dpo_get (proto));
319 else if (unformat (input, "punt"))
320 dpo_copy (dpo, punt_dpo_get (proto));
321 else if (unformat (input, "local"))
322 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
323 else if (unformat (input, "null-send-unreach"))
324 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
325 else if (unformat (input, "null-send-prohibit"))
326 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
327 else if (unformat (input, "null"))
328 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
329 else if (unformat (input, "classify"))
331 u32 classify_table_index;
333 if (!unformat (input, "%d", &classify_table_index))
335 clib_warning ("classify adj must specify table index");
339 dpo_set (dpo, DPO_CLASSIFY, proto,
340 classify_dpo_create (proto, classify_table_index));
348 const ip46_address_t zero_addr = {
354 vnet_ip_route_cmd (vlib_main_t * vm,
355 unformat_input_t * main_input, vlib_cli_command_t * cmd)
357 unformat_input_t _line_input, *line_input = &_line_input;
358 fib_route_path_t *rpaths = NULL, rpath;
359 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
360 fib_prefix_t *prefixs = NULL, pfx;
361 mpls_label_t out_label, via_label;
362 clib_error_t *error = NULL;
363 u32 table_id, is_del;
369 vnm = vnet_get_main ();
373 memset (&pfx, 0, sizeof (pfx));
374 out_label = via_label = MPLS_LABEL_INVALID;
376 /* Get a line of input. */
377 if (!unformat_user (main_input, unformat_line_input, line_input))
380 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
382 memset (&rpath, 0, sizeof (rpath));
384 if (unformat (line_input, "table %d", &table_id))
386 else if (unformat (line_input, "del"))
388 else if (unformat (line_input, "add"))
390 else if (unformat (line_input, "resolve-via-host"))
392 if (vec_len (rpaths) == 0)
394 error = clib_error_return (0, "Paths then flags");
397 rpaths[vec_len (rpaths) - 1].frp_flags |=
398 FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
400 else if (unformat (line_input, "resolve-via-attached"))
402 if (vec_len (rpaths) == 0)
404 error = clib_error_return (0, "Paths then flags");
407 rpaths[vec_len (rpaths) - 1].frp_flags |=
408 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
410 else if (unformat (line_input, "out-label %U",
411 unformat_mpls_unicast_label, &out_label))
413 if (vec_len (rpaths) == 0)
415 error = clib_error_return (0, "Paths then labels");
418 vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack, out_label);
420 else if (unformat (line_input, "via-label %U",
421 unformat_mpls_unicast_label, &rpath.frp_local_label))
423 rpath.frp_weight = 1;
424 rpath.frp_eos = MPLS_NON_EOS;
425 rpath.frp_proto = FIB_PROTOCOL_MPLS;
426 rpath.frp_sw_if_index = ~0;
427 vec_add1 (rpaths, rpath);
429 else if (unformat (line_input, "count %f", &count))
432 else if (unformat (line_input, "%U/%d",
433 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
435 pfx.fp_proto = FIB_PROTOCOL_IP4;
436 vec_add1 (prefixs, pfx);
438 else if (unformat (line_input, "%U/%d",
439 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
441 pfx.fp_proto = FIB_PROTOCOL_IP6;
442 vec_add1 (prefixs, pfx);
444 else if (unformat (line_input, "via %U %U weight %u",
445 unformat_ip4_address,
447 unformat_vnet_sw_interface, vnm,
448 &rpath.frp_sw_if_index, &rpath.frp_weight))
450 rpath.frp_proto = FIB_PROTOCOL_IP4;
451 vec_add1 (rpaths, rpath);
454 else if (unformat (line_input, "via %U %U weight %u",
455 unformat_ip6_address,
457 unformat_vnet_sw_interface, vnm,
458 &rpath.frp_sw_if_index, &rpath.frp_weight))
460 rpath.frp_proto = FIB_PROTOCOL_IP6;
461 vec_add1 (rpaths, rpath);
464 else if (unformat (line_input, "via %U %U",
465 unformat_ip4_address,
467 unformat_vnet_sw_interface, vnm,
468 &rpath.frp_sw_if_index))
470 rpath.frp_weight = 1;
471 rpath.frp_proto = FIB_PROTOCOL_IP4;
472 vec_add1 (rpaths, rpath);
475 else if (unformat (line_input, "via %U %U",
476 unformat_ip6_address,
478 unformat_vnet_sw_interface, vnm,
479 &rpath.frp_sw_if_index))
481 rpath.frp_weight = 1;
482 rpath.frp_proto = FIB_PROTOCOL_IP6;
483 vec_add1 (rpaths, rpath);
485 else if (unformat (line_input, "via %U next-hop-table %d",
486 unformat_ip4_address,
487 &rpath.frp_addr.ip4, &rpath.frp_fib_index))
489 rpath.frp_weight = 1;
490 rpath.frp_sw_if_index = ~0;
491 rpath.frp_proto = FIB_PROTOCOL_IP4;
492 vec_add1 (rpaths, rpath);
494 else if (unformat (line_input, "via %U next-hop-table %d",
495 unformat_ip6_address,
496 &rpath.frp_addr.ip6, &rpath.frp_fib_index))
498 rpath.frp_weight = 1;
499 rpath.frp_sw_if_index = ~0;
500 rpath.frp_proto = FIB_PROTOCOL_IP6;
501 vec_add1 (rpaths, rpath);
503 else if (unformat (line_input, "via %U",
504 unformat_ip4_address, &rpath.frp_addr.ip4))
507 * the recursive next-hops are by default in the same table
510 rpath.frp_fib_index = table_id;
511 rpath.frp_weight = 1;
512 rpath.frp_sw_if_index = ~0;
513 rpath.frp_proto = FIB_PROTOCOL_IP4;
514 vec_add1 (rpaths, rpath);
516 else if (unformat (line_input, "via %U",
517 unformat_ip6_address, &rpath.frp_addr.ip6))
519 rpath.frp_fib_index = table_id;
520 rpath.frp_weight = 1;
521 rpath.frp_sw_if_index = ~0;
522 rpath.frp_proto = FIB_PROTOCOL_IP6;
523 vec_add1 (rpaths, rpath);
525 else if (unformat (line_input,
526 "lookup in table %d", &rpath.frp_fib_index))
528 rpath.frp_proto = pfx.fp_proto;
529 rpath.frp_sw_if_index = ~0;
530 vec_add1 (rpaths, rpath);
532 else if (vec_len (prefixs) > 0 &&
533 unformat (line_input, "via %U",
534 unformat_vnet_sw_interface, vnm,
535 &rpath.frp_sw_if_index))
537 rpath.frp_weight = 1;
538 rpath.frp_proto = prefixs[0].fp_proto;
539 vec_add1 (rpaths, rpath);
541 else if (vec_len (prefixs) > 0 &&
542 unformat (line_input, "via %U",
543 unformat_dpo, &dpo, prefixs[0].fp_proto))
545 vec_add1 (dpos, dpo);
549 error = unformat_parse_error (line_input);
554 if (vec_len (prefixs) == 0)
557 clib_error_return (0, "expected ip4/ip6 destination address/length.");
561 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
563 error = clib_error_return (0, "expected paths.");
570 * if no table_id is passed we will manipulate the default
576 fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
580 error = clib_error_return (0, "Nonexistent table id %d", table_id);
585 for (i = 0; i < vec_len (prefixs); i++)
587 if (is_del && 0 == vec_len (rpaths))
589 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
591 else if (!is_del && 1 == vec_len (dpos))
593 fib_table_entry_special_dpo_add (fib_index,
596 FIB_ENTRY_FLAG_EXCLUSIVE,
598 dpo_reset (&dpos[0]);
600 else if (vec_len (dpos) > 0)
603 clib_error_return (0,
604 "Load-balancing over multiple special adjacencies is unsupported");
607 else if (0 < vec_len (rpaths))
610 ip46_address_t dst = prefixs[i].fp_addr;
613 t[0] = vlib_time_now (vm);
614 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
617 for (k = 0; k < n; k++)
619 for (j = 0; j < vec_len (rpaths); j++)
623 * the CLI parsing stored table Ids, swap to FIB indicies
625 fi = fib_table_find (prefixs[i].fp_proto,
626 rpaths[i].frp_fib_index);
631 clib_error_return (0, "Via table %d does not exist",
632 rpaths[i].frp_fib_index);
635 rpaths[i].frp_fib_index = fi;
637 fib_prefix_t rpfx = {
638 .fp_len = prefixs[i].fp_len,
639 .fp_proto = prefixs[i].fp_proto,
644 fib_table_entry_path_remove2 (fib_index,
646 FIB_SOURCE_CLI, &rpaths[j]);
648 fib_table_entry_path_add2 (fib_index,
655 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
658 clib_host_to_net_u32 (incr +
659 clib_net_to_host_u32 (dst.
664 int bucket = (incr < 64 ? 0 : 1);
665 dst.ip6.as_u64[bucket] =
666 clib_host_to_net_u64 (incr +
667 clib_net_to_host_u64 (dst.ip6.as_u64
672 t[1] = vlib_time_now (vm);
674 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
678 error = clib_error_return (0, "Don't understand what you want...");
688 unformat_free (line_input);
693 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
695 .short_help = "Internet protocol (IP) commands",
700 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
702 .short_help = "Internet protocol version 6 (IPv6) commands",
707 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
709 .short_help = "Internet protocol (IP) show commands",
714 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
716 .short_help = "Internet protocol version 6 (IPv6) show commands",
721 * This command is used to add or delete IPv4 or IPv6 routes. All
722 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
723 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
724 * can be IPv4 or IPv6, but all must be of the same form in a single
725 * command. To display the current set of routes, use the commands
726 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
729 * Example of how to add a straight forward static route:
730 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
731 * Example of how to delete a straight forward static route:
732 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
733 * Mainly for route add/del performance testing, one can add or delete
734 * multiple routes by adding 'count N' to the previous item:
735 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
736 * Add multiple routes for the same destination to create equal-cost multipath:
737 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
738 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
739 * For unequal-cost multipath, specify the desired weights. This
740 * combination of weights results in 3/4 of the traffic following the
741 * second path, 1/4 following the first path:
742 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
743 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
744 * To add a route to a particular FIB table (VRF), use:
745 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
748 VLIB_CLI_COMMAND (ip_route_command, static) = {
750 .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>]",
751 .function = vnet_ip_route_cmd,
757 vnet_ip_mroute_cmd (vlib_main_t * vm,
758 unformat_input_t * main_input, vlib_cli_command_t * cmd)
760 unformat_input_t _line_input, *line_input = &_line_input;
761 clib_error_t *error = NULL;
762 fib_route_path_t rpath;
763 u32 table_id, is_del;
767 mfib_itf_flags_t iflags = 0;
768 mfib_entry_flags_t eflags = 0;
769 u32 gcount, scount, ss, gg, incr;
773 vnm = vnet_get_main ();
776 memset (&pfx, 0, sizeof (pfx));
777 memset (&rpath, 0, sizeof (rpath));
778 rpath.frp_sw_if_index = ~0;
780 /* Get a line of input. */
781 if (!unformat_user (main_input, unformat_line_input, line_input))
784 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
786 if (unformat (line_input, "table %d", &table_id))
788 else if (unformat (line_input, "del"))
790 else if (unformat (line_input, "add"))
792 else if (unformat (line_input, "scount %d", &scount))
794 else if (unformat (line_input, "gcount %d", &gcount))
796 else if (unformat (line_input, "%U %U",
797 unformat_ip4_address,
798 &pfx.fp_src_addr.ip4,
799 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
801 pfx.fp_proto = FIB_PROTOCOL_IP4;
804 else if (unformat (line_input, "%U %U",
805 unformat_ip6_address,
806 &pfx.fp_src_addr.ip6,
807 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
809 pfx.fp_proto = FIB_PROTOCOL_IP6;
812 else if (unformat (line_input, "%U/%d",
813 unformat_ip4_address,
814 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
816 pfx.fp_proto = FIB_PROTOCOL_IP4;
818 else if (unformat (line_input, "%U/%d",
819 unformat_ip6_address,
820 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
822 pfx.fp_proto = FIB_PROTOCOL_IP6;
824 else if (unformat (line_input, "%U",
825 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
827 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
828 pfx.fp_proto = FIB_PROTOCOL_IP4;
831 else if (unformat (line_input, "%U",
832 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
834 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
835 pfx.fp_proto = FIB_PROTOCOL_IP6;
838 else if (unformat (line_input, "via %U",
839 unformat_vnet_sw_interface, vnm,
840 &rpath.frp_sw_if_index))
842 rpath.frp_weight = 1;
844 else if (unformat (line_input, "via local"))
846 rpath.frp_sw_if_index = ~0;
847 rpath.frp_weight = 1;
848 rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
850 else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
852 else if (unformat (line_input, "%U",
853 unformat_mfib_entry_flags, &eflags))
857 error = unformat_parse_error (line_input);
865 * if no table_id is passed we will manipulate the default
871 fib_index = mfib_table_find (pfx.fp_proto, table_id);
875 error = clib_error_return (0, "Nonexistent table id %d", table_id);
880 timet[0] = vlib_time_now (vm);
882 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
884 incr = 1 << (32 - (pfx.fp_len % 32));
888 incr = 1 << (128 - (pfx.fp_len % 128));
891 for (ss = 0; ss < scount; ss++)
893 for (gg = 0; gg < gcount; gg++)
895 if (is_del && 0 == rpath.frp_weight)
897 /* no path provided => route delete */
898 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
902 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
903 MFIB_RPF_ID_NONE, eflags);
908 mfib_table_entry_path_remove (fib_index,
909 &pfx, MFIB_SOURCE_CLI, &rpath);
911 mfib_table_entry_path_update (fib_index,
912 &pfx, MFIB_SOURCE_CLI, &rpath,
916 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
918 pfx.fp_grp_addr.ip4.as_u32 =
919 clib_host_to_net_u32 (incr +
920 clib_net_to_host_u32 (pfx.
926 int bucket = (incr < 64 ? 0 : 1);
927 pfx.fp_grp_addr.ip6.as_u64[bucket] =
928 clib_host_to_net_u64 (incr +
929 clib_net_to_host_u64 (pfx.
930 fp_grp_addr.ip6.as_u64
935 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
937 pfx.fp_src_addr.ip4.as_u32 =
938 clib_host_to_net_u32 (1 +
939 clib_net_to_host_u32 (pfx.fp_src_addr.
944 pfx.fp_src_addr.ip6.as_u64[1] =
945 clib_host_to_net_u64 (1 +
946 clib_net_to_host_u64 (pfx.fp_src_addr.
951 timet[1] = vlib_time_now (vm);
953 if (scount > 1 || gcount > 1)
954 vlib_cli_output (vm, "%.6e routes/sec",
955 (scount * gcount) / (timet[1] - timet[0]));
958 unformat_free (line_input);
964 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
965 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
966 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
967 * can be IPv4 or IPv6, but all must be of the same form in a single
968 * command. To display the current set of routes, use the commands
969 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
970 * The full set of support flags for interfaces and route is shown via;
971 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
974 * Example of how to add a forwarding interface to a route (and create the
975 * route if it does not exist)
976 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
977 * Example of how to add an accepting interface to a route (and create the
978 * route if it does not exist)
979 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
980 * Example of changing the route's flags to send signals via the API
981 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
985 VLIB_CLI_COMMAND (ip_mroute_command, static) =
988 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
989 .function = vnet_ip_mroute_cmd,
995 * The next two routines address a longstanding script hemorrhoid.
996 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
997 * or dependent route-adds will simply fail.
999 static clib_error_t *
1000 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1003 vnet_main_t *vnm = vnet_get_main ();
1008 uword *event_data = 0;
1010 ASSERT (vlib_in_process_context (vm));
1012 if (retry_count > 0)
1013 vnet_register_ip6_neighbor_resolution_event
1014 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1015 1 /* event */ , 0 /* data */ );
1017 for (i = 0; i < retry_count; i++)
1019 /* The interface may be down, etc. */
1020 e = ip6_probe_neighbor (vm, a, sw_if_index);
1025 vlib_process_wait_for_event_or_clock (vm, 1.0);
1026 event_type = vlib_process_get_events (vm, &event_data);
1029 case 1: /* resolved... */
1030 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1034 case ~0: /* timeout */
1038 clib_warning ("unknown event_type %d", event_type);
1040 vec_reset_length (event_data);
1046 return clib_error_return (0, "Resolution failed for %U",
1047 format_ip6_address, a);
1051 static clib_error_t *
1052 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1055 vnet_main_t *vnm = vnet_get_main ();
1060 uword *event_data = 0;
1062 ASSERT (vlib_in_process_context (vm));
1064 if (retry_count > 0)
1065 vnet_register_ip4_arp_resolution_event
1066 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1067 1 /* event */ , 0 /* data */ );
1069 for (i = 0; i < retry_count; i++)
1071 /* The interface may be down, etc. */
1072 e = ip4_probe_neighbor (vm, a, sw_if_index);
1077 vlib_process_wait_for_event_or_clock (vm, 1.0);
1078 event_type = vlib_process_get_events (vm, &event_data);
1081 case 1: /* resolved... */
1082 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1086 case ~0: /* timeout */
1090 clib_warning ("unknown event_type %d", event_type);
1092 vec_reset_length (event_data);
1097 vec_reset_length (event_data);
1100 return clib_error_return (0, "Resolution failed for %U",
1101 format_ip4_address, a);
1105 static clib_error_t *
1106 probe_neighbor_address (vlib_main_t * vm,
1107 unformat_input_t * input, vlib_cli_command_t * cmd)
1109 vnet_main_t *vnm = vnet_get_main ();
1110 unformat_input_t _line_input, *line_input = &_line_input;
1113 clib_error_t *error = 0;
1114 u32 sw_if_index = ~0;
1115 int retry_count = 3;
1117 int address_set = 0;
1119 /* Get a line of input. */
1120 if (!unformat_user (input, unformat_line_input, line_input))
1123 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1125 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1128 else if (unformat (line_input, "retry %d", &retry_count))
1131 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1133 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1140 error = clib_error_return (0, "unknown input '%U'",
1141 format_unformat_error, line_input);
1146 if (sw_if_index == ~0)
1148 error = clib_error_return (0, "Interface required, not set.");
1151 if (address_set == 0)
1153 error = clib_error_return (0, "ip address required, not set.");
1156 if (address_set > 1)
1158 error = clib_error_return (0, "Multiple ip addresses not supported.");
1163 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1165 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1168 unformat_free (line_input);
1174 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1175 * attempts IPv6 neighbor discovery depending on the supplied IP address
1178 * @note This command will not immediately affect the indicated FIB; it
1179 * is not suitable for use in establishing a FIB entry prior to adding
1180 * recursive FIB entries. As in: don't use it in a script to probe a
1181 * gateway prior to adding a default route. It won't work. Instead,
1182 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1183 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1186 * Example of probe for an IPv4 address:
1187 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1190 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1191 .path = "ip probe-neighbor",
1192 .function = probe_neighbor_address,
1193 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1199 * fd.io coding-style-patch-verification: ON
1202 * eval: (c-set-style "gnu")