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>
55 * @brief IPv4 and IPv6 adjacency and lookup table managment.
60 ip_interface_address_add_del (ip_lookup_main_t * lm,
64 u32 is_del, 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,
72 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
74 /* Verify given length. */
75 if ((a && (address_length != a->address_length)) || (address_length == 0))
77 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
78 return clib_error_create
79 ("%U wrong length (expected %d) for interface %U",
80 lm->format_address_and_length, addr_fib,
81 address_length, a ? a->address_length : -1,
82 format_vnet_sw_if_index_name, vnm, sw_if_index);
89 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
90 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
91 return clib_error_create ("%U not found for interface %U",
92 lm->format_address_and_length,
93 addr_fib, address_length,
94 format_vnet_sw_interface_name, vnm, si);
97 if (a->prev_this_sw_interface != ~0)
100 pool_elt_at_index (lm->if_address_pool,
101 a->prev_this_sw_interface);
102 prev->next_this_sw_interface = a->next_this_sw_interface;
104 if (a->next_this_sw_interface != ~0)
107 pool_elt_at_index (lm->if_address_pool,
108 a->next_this_sw_interface);
109 next->prev_this_sw_interface = a->prev_this_sw_interface;
111 if (a->prev_this_sw_interface == ~0)
112 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
113 a->next_this_sw_interface;
116 if ((a->next_this_sw_interface == ~0)
117 && (a->prev_this_sw_interface == ~0))
118 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
120 mhash_unset (&lm->address_to_if_address_index, addr_fib,
122 pool_put (lm->if_address_pool, a);
124 if (result_if_address_index)
125 *result_if_address_index = ~0;
130 u32 pi; /* previous index */
132 u32 hi; /* head index */
134 pool_get (lm->if_address_pool, a);
135 memset (a, ~0, sizeof (a[0]));
136 ai = a - lm->if_address_pool;
138 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
140 while (pi != (u32) ~ 0)
142 prev = pool_elt_at_index (lm->if_address_pool, pi);
143 pi = prev->next_this_sw_interface;
145 pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
147 a->address_key = mhash_set (&lm->address_to_if_address_index,
148 addr_fib, ai, /* old_value */ 0);
149 a->address_length = address_length;
150 a->sw_if_index = sw_if_index;
152 a->prev_this_sw_interface = pi;
153 a->next_this_sw_interface = ~0;
155 prev->next_this_sw_interface = ai;
157 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
158 (hi != ~0) ? hi : ai;
159 if (result_if_address_index)
160 *result_if_address_index = ai;
164 if (result_if_address_index)
165 *result_if_address_index = a - lm->if_address_pool;
169 return /* no error */ 0;
173 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
175 /* ensure that adjacency is cacheline aligned and sized */
176 STATIC_ASSERT (STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0,
177 "Cache line marker must be 1st element in struct");
178 STATIC_ASSERT (STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
179 CLIB_CACHE_LINE_BYTES,
180 "Data in cache line 0 is bigger than cache line size");
182 /* Preallocate three "special" adjacencies */
183 lm->adjacency_heap = adj_pool;
185 if (!lm->fib_result_n_bytes)
186 lm->fib_result_n_bytes = sizeof (uword);
191 lm->format_address_and_length = format_ip6_address_and_length;
192 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
193 sizeof (ip6_address_fib_t));
197 lm->format_address_and_length = format_ip4_address_and_length;
198 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
199 sizeof (ip4_address_fib_t));
205 /* Setup all IP protocols to be punted and builtin-unknown. */
206 for (i = 0; i < 256; i++)
208 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
209 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
212 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
213 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
214 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
215 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
216 IP_BUILTIN_PROTOCOL_UDP;
217 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
219 IP_BUILTIN_PROTOCOL_ICMP;
224 format_ip_flow_hash_config (u8 * s, va_list * args)
226 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
228 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
229 foreach_flow_hash_bit;
236 format_ip_lookup_next (u8 * s, va_list * args)
238 ip_lookup_next_t n = va_arg (*args, ip_lookup_next_t);
244 s = format (s, "unknown %d", n);
247 case IP_LOOKUP_NEXT_DROP:
250 case IP_LOOKUP_NEXT_PUNT:
253 case IP_LOOKUP_NEXT_ARP:
256 case IP_LOOKUP_NEXT_MIDCHAIN:
259 case IP_LOOKUP_NEXT_GLEAN:
262 case IP_LOOKUP_NEXT_MCAST:
265 case IP_LOOKUP_NEXT_REWRITE:
270 vec_add (s, t, strlen (t));
276 format_ip_adjacency_packet_data (u8 * s, va_list * args)
278 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
279 u32 adj_index = va_arg (*args, u32);
280 u8 *packet_data = va_arg (*args, u8 *);
281 u32 n_packet_data_bytes = va_arg (*args, u32);
282 ip_adjacency_t *adj = adj_get (adj_index);
284 switch (adj->lookup_next_index)
286 case IP_LOOKUP_NEXT_REWRITE:
288 format_vnet_rewrite_header,
289 vnm->vlib_main, &adj->rewrite_header, packet_data,
290 n_packet_data_bytes);
301 unformat_dpo (unformat_input_t * input, va_list * args)
303 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
304 fib_protocol_t fp = va_arg (*args, int);
307 proto = fib_proto_to_dpo (fp);
309 if (unformat (input, "drop"))
310 dpo_copy (dpo, drop_dpo_get (proto));
311 else if (unformat (input, "punt"))
312 dpo_copy (dpo, punt_dpo_get (proto));
313 else if (unformat (input, "local"))
314 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
315 else if (unformat (input, "null-send-unreach"))
316 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
317 else if (unformat (input, "null-send-prohibit"))
318 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
319 else if (unformat (input, "null"))
320 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
321 else if (unformat (input, "classify"))
323 u32 classify_table_index;
325 if (!unformat (input, "%d", &classify_table_index))
327 clib_warning ("classify adj must specify table index");
331 dpo_set (dpo, DPO_CLASSIFY, proto,
332 classify_dpo_create (proto, classify_table_index));
340 const ip46_address_t zero_addr = {
346 fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id)
348 ip4_main_t *im4 = &ip4_main;
349 ip6_main_t *im6 = &ip6_main;
354 case FIB_PROTOCOL_IP4:
355 p = hash_get (im4->fib_index_by_table_id, table_id);
357 case FIB_PROTOCOL_IP6:
358 p = hash_get (im6->fib_index_by_table_id, table_id);
372 vnet_ip_route_cmd (vlib_main_t * vm,
373 unformat_input_t * main_input, vlib_cli_command_t * cmd)
375 unformat_input_t _line_input, *line_input = &_line_input;
376 fib_route_path_t *rpaths = NULL, rpath;
377 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
378 fib_prefix_t *prefixs = NULL, pfx;
379 mpls_label_t out_label, via_label;
380 clib_error_t *error = NULL;
381 u32 table_id, is_del;
387 vnm = vnet_get_main ();
391 memset (&pfx, 0, sizeof (pfx));
392 out_label = via_label = MPLS_LABEL_INVALID;
394 /* Get a line of input. */
395 if (!unformat_user (main_input, unformat_line_input, line_input))
398 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
400 memset (&rpath, 0, sizeof (rpath));
402 if (unformat (line_input, "table %d", &table_id))
404 else if (unformat (line_input, "del"))
406 else if (unformat (line_input, "add"))
408 else if (unformat (line_input, "resolve-via-host"))
410 if (vec_len (rpaths) == 0)
412 error = clib_error_return (0, "Paths then flags");
415 rpaths[vec_len (rpaths) - 1].frp_flags |=
416 FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
418 else if (unformat (line_input, "resolve-via-attached"))
420 if (vec_len (rpaths) == 0)
422 error = clib_error_return (0, "Paths then flags");
425 rpaths[vec_len (rpaths) - 1].frp_flags |=
426 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
428 else if (unformat (line_input, "out-label %U",
429 unformat_mpls_unicast_label, &out_label))
431 if (vec_len (rpaths) == 0)
433 error = clib_error_return (0, "Paths then labels");
436 vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack, out_label);
438 else if (unformat (line_input, "via-label %U",
439 unformat_mpls_unicast_label, &rpath.frp_local_label))
441 rpath.frp_weight = 1;
442 rpath.frp_proto = FIB_PROTOCOL_MPLS;
443 rpath.frp_sw_if_index = ~0;
444 vec_add1 (rpaths, rpath);
446 else if (unformat (line_input, "count %f", &count))
449 else if (unformat (line_input, "%U/%d",
450 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
452 pfx.fp_proto = FIB_PROTOCOL_IP4;
453 vec_add1 (prefixs, pfx);
455 else if (unformat (line_input, "%U/%d",
456 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
458 pfx.fp_proto = FIB_PROTOCOL_IP6;
459 vec_add1 (prefixs, pfx);
461 else if (unformat (line_input, "via %U %U weight %u",
462 unformat_ip4_address,
464 unformat_vnet_sw_interface, vnm,
465 &rpath.frp_sw_if_index, &rpath.frp_weight))
467 rpath.frp_proto = FIB_PROTOCOL_IP4;
468 vec_add1 (rpaths, rpath);
471 else if (unformat (line_input, "via %U %U weight %u",
472 unformat_ip6_address,
474 unformat_vnet_sw_interface, vnm,
475 &rpath.frp_sw_if_index, &rpath.frp_weight))
477 rpath.frp_proto = FIB_PROTOCOL_IP6;
478 vec_add1 (rpaths, rpath);
481 else if (unformat (line_input, "via %U %U",
482 unformat_ip4_address,
484 unformat_vnet_sw_interface, vnm,
485 &rpath.frp_sw_if_index))
487 rpath.frp_weight = 1;
488 rpath.frp_proto = FIB_PROTOCOL_IP4;
489 vec_add1 (rpaths, rpath);
492 else if (unformat (line_input, "via %U %U",
493 unformat_ip6_address,
495 unformat_vnet_sw_interface, vnm,
496 &rpath.frp_sw_if_index))
498 rpath.frp_weight = 1;
499 rpath.frp_proto = FIB_PROTOCOL_IP6;
500 vec_add1 (rpaths, rpath);
502 else if (unformat (line_input, "via %U next-hop-table %d",
503 unformat_ip4_address,
504 &rpath.frp_addr.ip4, &rpath.frp_fib_index))
506 rpath.frp_weight = 1;
507 rpath.frp_sw_if_index = ~0;
508 rpath.frp_proto = FIB_PROTOCOL_IP4;
509 vec_add1 (rpaths, rpath);
511 else if (unformat (line_input, "via %U next-hop-table %d",
512 unformat_ip6_address,
513 &rpath.frp_addr.ip6, &rpath.frp_fib_index))
515 rpath.frp_weight = 1;
516 rpath.frp_sw_if_index = ~0;
517 rpath.frp_proto = FIB_PROTOCOL_IP6;
518 vec_add1 (rpaths, rpath);
520 else if (unformat (line_input, "via %U",
521 unformat_ip4_address, &rpath.frp_addr.ip4))
524 * the recursive next-hops are by default in the same table
527 rpath.frp_fib_index = table_id;
528 rpath.frp_weight = 1;
529 rpath.frp_sw_if_index = ~0;
530 rpath.frp_proto = FIB_PROTOCOL_IP4;
531 vec_add1 (rpaths, rpath);
533 else if (unformat (line_input, "via %U",
534 unformat_ip6_address, &rpath.frp_addr.ip6))
536 rpath.frp_fib_index = table_id;
537 rpath.frp_weight = 1;
538 rpath.frp_sw_if_index = ~0;
539 rpath.frp_proto = FIB_PROTOCOL_IP6;
540 vec_add1 (rpaths, rpath);
542 else if (unformat (line_input,
543 "lookup in table %d", &rpath.frp_fib_index))
545 rpath.frp_proto = pfx.fp_proto;
546 rpath.frp_sw_if_index = ~0;
547 vec_add1 (rpaths, rpath);
549 else if (vec_len (prefixs) > 0 &&
550 unformat (line_input, "via %U",
551 unformat_vnet_sw_interface, vnm,
552 &rpath.frp_sw_if_index))
554 rpath.frp_weight = 1;
555 rpath.frp_proto = prefixs[0].fp_proto;
556 vec_add1 (rpaths, rpath);
558 else if (vec_len (prefixs) > 0 &&
559 unformat (line_input, "via %U",
560 unformat_dpo, &dpo, prefixs[0].fp_proto))
562 vec_add1 (dpos, dpo);
566 error = unformat_parse_error (line_input);
571 unformat_free (line_input);
573 if (vec_len (prefixs) == 0)
576 clib_error_return (0, "expected ip4/ip6 destination address/length.");
580 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
582 error = clib_error_return (0, "expected paths.");
589 * if no table_id is passed we will manipulate the default
595 fib_index = fib_table_id_find_fib_index (prefixs[0].fp_proto, table_id);
599 error = clib_error_return (0, "Nonexistent table id %d", table_id);
604 for (i = 0; i < vec_len (prefixs); i++)
606 if (is_del && 0 == vec_len (rpaths))
608 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
610 else if (!is_del && 1 == vec_len (dpos))
612 fib_table_entry_special_dpo_add (fib_index,
615 FIB_ENTRY_FLAG_EXCLUSIVE,
617 dpo_reset (&dpos[0]);
619 else if (vec_len (dpos) > 0)
622 clib_error_return (0,
623 "Load-balancing over multiple special adjacencies is unsupported");
626 else if (0 < vec_len (rpaths))
629 ip46_address_t dst = prefixs[i].fp_addr;
632 t[0] = vlib_time_now (vm);
633 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
636 for (k = 0; k < n; k++)
638 for (j = 0; j < vec_len (rpaths); j++)
642 * the CLI parsing stored table Ids, swap to FIB indicies
644 fi = fib_table_id_find_fib_index (prefixs[i].fp_proto,
645 rpaths[i].frp_fib_index);
650 clib_error_return (0, "Via table %d does not exist",
651 rpaths[i].frp_fib_index);
654 rpaths[i].frp_fib_index = fi;
656 fib_prefix_t rpfx = {
657 .fp_len = prefixs[i].fp_len,
658 .fp_proto = prefixs[i].fp_proto,
663 fib_table_entry_path_remove2 (fib_index,
665 FIB_SOURCE_CLI, &rpaths[j]);
667 fib_table_entry_path_add2 (fib_index,
674 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
677 clib_host_to_net_u32 (incr +
678 clib_net_to_host_u32 (dst.
683 int bucket = (incr < 64 ? 0 : 1);
684 dst.ip6.as_u64[bucket] =
685 clib_host_to_net_u64 (incr +
686 clib_net_to_host_u64 (dst.ip6.as_u64
691 t[1] = vlib_time_now (vm);
693 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
697 error = clib_error_return (0, "Don't understand what you want...");
711 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
713 .short_help = "Internet protocol (IP) commands",
718 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
720 .short_help = "Internet protocol version 6 (IPv6) commands",
725 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
727 .short_help = "Internet protocol (IP) show commands",
732 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
734 .short_help = "Internet protocol version 6 (IPv6) show commands",
739 * This command is used to add or delete IPv4 or IPv6 routes. All
740 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
741 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
742 * can be IPv4 or IPv6, but all must be of the same form in a single
743 * command. To display the current set of routes, use the commands
744 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
747 * Example of how to add a straight forward static route:
748 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
749 * Example of how to delete a straight forward static route:
750 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
751 * Mainly for route add/del performance testing, one can add or delete
752 * multiple routes by adding 'count N' to the previous item:
753 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
754 * Add multiple routes for the same destination to create equal-cost multipath:
755 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
756 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
757 * For unequal-cost multipath, specify the desired weights. This
758 * combination of weights results in 3/4 of the traffic following the
759 * second path, 1/4 following the first path:
760 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
761 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
762 * To add a route to a particular FIB table (VRF), use:
763 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
766 VLIB_CLI_COMMAND (ip_route_command, static) = {
768 .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>]",
769 .function = vnet_ip_route_cmd,
775 vnet_ip_mroute_cmd (vlib_main_t * vm,
776 unformat_input_t * main_input, vlib_cli_command_t * cmd)
778 unformat_input_t _line_input, *line_input = &_line_input;
779 clib_error_t *error = NULL;
780 fib_route_path_t rpath;
781 u32 table_id, is_del;
785 mfib_itf_flags_t iflags = 0;
786 mfib_entry_flags_t eflags = 0;
787 u32 gcount, scount, ss, gg, incr;
791 vnm = vnet_get_main ();
794 memset (&pfx, 0, sizeof (pfx));
795 memset (&rpath, 0, sizeof (rpath));
796 rpath.frp_sw_if_index = ~0;
798 /* Get a line of input. */
799 if (!unformat_user (main_input, unformat_line_input, line_input))
802 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
804 if (unformat (line_input, "table %d", &table_id))
806 else if (unformat (line_input, "del"))
808 else if (unformat (line_input, "add"))
810 else if (unformat (line_input, "scount %d", &scount))
812 else if (unformat (line_input, "gcount %d", &gcount))
814 else if (unformat (line_input, "%U %U",
815 unformat_ip4_address,
816 &pfx.fp_src_addr.ip4,
817 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
819 pfx.fp_proto = FIB_PROTOCOL_IP4;
822 else if (unformat (line_input, "%U %U",
823 unformat_ip6_address,
824 &pfx.fp_src_addr.ip6,
825 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
827 pfx.fp_proto = FIB_PROTOCOL_IP6;
830 else if (unformat (line_input, "%U/%d",
831 unformat_ip4_address,
832 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
834 pfx.fp_proto = FIB_PROTOCOL_IP4;
836 else if (unformat (line_input, "%U/%d",
837 unformat_ip6_address,
838 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
840 pfx.fp_proto = FIB_PROTOCOL_IP6;
842 else if (unformat (line_input, "%U",
843 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
845 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
846 pfx.fp_proto = FIB_PROTOCOL_IP4;
849 else if (unformat (line_input, "%U",
850 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
852 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
853 pfx.fp_proto = FIB_PROTOCOL_IP6;
856 else if (unformat (line_input, "via %U",
857 unformat_vnet_sw_interface, vnm,
858 &rpath.frp_sw_if_index))
860 rpath.frp_weight = 1;
861 rpath.frp_proto = FIB_PROTOCOL_IP4;
863 else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
865 else if (unformat (line_input, "%U",
866 unformat_mfib_entry_flags, &eflags))
870 error = unformat_parse_error (line_input);
875 unformat_free (line_input);
880 * if no table_id is passed we will manipulate the default
886 fib_index = mfib_table_find (pfx.fp_proto, table_id);
890 error = clib_error_return (0, "Nonexistent table id %d", table_id);
895 timet[0] = vlib_time_now (vm);
897 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
899 incr = 1 << (32 - (pfx.fp_len % 32));
903 incr = 1 << (128 - (pfx.fp_len % 128));
906 for (ss = 0; ss < scount; ss++)
908 for (gg = 0; gg < gcount; gg++)
910 if (is_del && 0 == rpath.frp_weight)
912 /* no path provided => route delete */
913 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
917 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
923 mfib_table_entry_path_remove (fib_index,
924 &pfx, MFIB_SOURCE_CLI, &rpath);
926 mfib_table_entry_path_update (fib_index,
927 &pfx, MFIB_SOURCE_CLI, &rpath,
931 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
933 pfx.fp_grp_addr.ip4.as_u32 =
934 clib_host_to_net_u32 (incr +
935 clib_net_to_host_u32 (pfx.
941 int bucket = (incr < 64 ? 0 : 1);
942 pfx.fp_grp_addr.ip6.as_u64[bucket] =
943 clib_host_to_net_u64 (incr +
944 clib_net_to_host_u64 (pfx.
945 fp_grp_addr.ip6.as_u64
950 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
952 pfx.fp_src_addr.ip4.as_u32 =
953 clib_host_to_net_u32 (1 +
954 clib_net_to_host_u32 (pfx.fp_src_addr.
959 pfx.fp_src_addr.ip6.as_u64[1] =
960 clib_host_to_net_u64 (1 +
961 clib_net_to_host_u64 (pfx.fp_src_addr.
966 timet[1] = vlib_time_now (vm);
968 if (scount > 1 || gcount > 1)
969 vlib_cli_output (vm, "%.6e routes/sec",
970 (scount * gcount) / (timet[1] - timet[0]));
977 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
978 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
979 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
980 * can be IPv4 or IPv6, but all must be of the same form in a single
981 * command. To display the current set of routes, use the commands
982 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
983 * The full set of support flags for interfaces and route is shown via;
984 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
987 * Example of how to add a forwarding interface to a route (and create the
988 * route if it does not exist)
989 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
990 * Example of how to add an accepting interface to a route (and create the
991 * route if it does not exist)
992 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
993 * Example of changing the route's flags to send signals via the API
994 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
998 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1000 .path = "ip mroute",
1001 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1002 .function = vnet_ip_mroute_cmd,
1008 * The next two routines address a longstanding script hemorrhoid.
1009 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1010 * or dependent route-adds will simply fail.
1012 static clib_error_t *
1013 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1016 vnet_main_t *vnm = vnet_get_main ();
1021 uword *event_data = 0;
1023 ASSERT (vlib_in_process_context (vm));
1025 if (retry_count > 0)
1026 vnet_register_ip6_neighbor_resolution_event
1027 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1028 1 /* event */ , 0 /* data */ );
1030 for (i = 0; i < retry_count; i++)
1032 /* The interface may be down, etc. */
1033 e = ip6_probe_neighbor (vm, a, sw_if_index);
1038 vlib_process_wait_for_event_or_clock (vm, 1.0);
1039 event_type = vlib_process_get_events (vm, &event_data);
1042 case 1: /* resolved... */
1043 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1047 case ~0: /* timeout */
1051 clib_warning ("unknown event_type %d", event_type);
1053 vec_reset_length (event_data);
1059 return clib_error_return (0, "Resolution failed for %U",
1060 format_ip6_address, a);
1064 static clib_error_t *
1065 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1068 vnet_main_t *vnm = vnet_get_main ();
1073 uword *event_data = 0;
1075 ASSERT (vlib_in_process_context (vm));
1077 if (retry_count > 0)
1078 vnet_register_ip4_arp_resolution_event
1079 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1080 1 /* event */ , 0 /* data */ );
1082 for (i = 0; i < retry_count; i++)
1084 /* The interface may be down, etc. */
1085 e = ip4_probe_neighbor (vm, a, sw_if_index);
1090 vlib_process_wait_for_event_or_clock (vm, 1.0);
1091 event_type = vlib_process_get_events (vm, &event_data);
1094 case 1: /* resolved... */
1095 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1099 case ~0: /* timeout */
1103 clib_warning ("unknown event_type %d", event_type);
1105 vec_reset_length (event_data);
1110 vec_reset_length (event_data);
1113 return clib_error_return (0, "Resolution failed for %U",
1114 format_ip4_address, a);
1118 static clib_error_t *
1119 probe_neighbor_address (vlib_main_t * vm,
1120 unformat_input_t * input, vlib_cli_command_t * cmd)
1122 vnet_main_t *vnm = vnet_get_main ();
1123 unformat_input_t _line_input, *line_input = &_line_input;
1126 clib_error_t *error = 0;
1127 u32 sw_if_index = ~0;
1128 int retry_count = 3;
1130 int address_set = 0;
1132 /* Get a line of input. */
1133 if (!unformat_user (input, unformat_line_input, line_input))
1136 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1138 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1141 else if (unformat (line_input, "retry %d", &retry_count))
1144 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1146 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1152 return clib_error_return (0, "unknown input '%U'",
1153 format_unformat_error, line_input);
1156 unformat_free (line_input);
1158 if (sw_if_index == ~0)
1159 return clib_error_return (0, "Interface required, not set.");
1160 if (address_set == 0)
1161 return clib_error_return (0, "ip address required, not set.");
1162 if (address_set > 1)
1163 return clib_error_return (0, "Multiple ip addresses not supported.");
1166 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1168 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
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")