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 (sw_if_index != a->sw_if_index)
170 if (result_if_address_index)
171 *result_if_address_index = ~0;
172 vnm->api_errno = VNET_API_ERROR_DUPLICATE_IF_ADDRESS;
173 return clib_error_create
174 ("Prefix %U already found on interface %U",
175 lm->format_address_and_length, addr_fib, address_length,
176 format_vnet_sw_if_index_name, vnm, a->sw_if_index);
179 if (result_if_address_index)
180 *result_if_address_index = a - lm->if_address_pool;
183 return /* no error */ 0;
186 static clib_error_t *
187 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
189 vec_validate_init_empty (ip4_main.
190 lookup_main.if_address_pool_index_by_sw_if_index,
192 vec_validate_init_empty (ip6_main.
193 lookup_main.if_address_pool_index_by_sw_if_index,
199 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
202 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
204 if (!lm->fib_result_n_bytes)
205 lm->fib_result_n_bytes = sizeof (uword);
210 lm->format_address_and_length = format_ip6_address_and_length;
211 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
212 sizeof (ip6_address_fib_t));
216 lm->format_address_and_length = format_ip4_address_and_length;
217 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
218 sizeof (ip4_address_fib_t));
224 /* Setup all IP protocols to be punted and builtin-unknown. */
225 for (i = 0; i < 256; i++)
227 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
228 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
231 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
232 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
233 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
234 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
235 IP_BUILTIN_PROTOCOL_UDP;
236 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
238 IP_BUILTIN_PROTOCOL_ICMP;
243 format_ip_flow_hash_config (u8 * s, va_list * args)
245 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
247 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
248 foreach_flow_hash_bit;
255 format_ip_lookup_next (u8 * s, va_list * args)
257 /* int promotion of ip_lookup_next_t */
258 ip_lookup_next_t n = va_arg (*args, int);
264 s = format (s, "unknown %d", n);
267 case IP_LOOKUP_NEXT_DROP:
270 case IP_LOOKUP_NEXT_PUNT:
273 case IP_LOOKUP_NEXT_ARP:
276 case IP_LOOKUP_NEXT_MIDCHAIN:
279 case IP_LOOKUP_NEXT_GLEAN:
282 case IP_LOOKUP_NEXT_MCAST:
285 case IP_LOOKUP_NEXT_REWRITE:
290 vec_add (s, t, strlen (t));
296 format_ip_adjacency_packet_data (u8 * s, va_list * args)
298 u32 adj_index = va_arg (*args, u32);
299 u8 *packet_data = va_arg (*args, u8 *);
300 u32 n_packet_data_bytes = va_arg (*args, u32);
301 ip_adjacency_t *adj = adj_get (adj_index);
303 switch (adj->lookup_next_index)
305 case IP_LOOKUP_NEXT_REWRITE:
306 case IP_LOOKUP_NEXT_MCAST:
308 format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
319 unformat_dpo (unformat_input_t * input, va_list * args)
321 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
322 fib_protocol_t fp = va_arg (*args, int);
325 proto = fib_proto_to_dpo (fp);
327 if (unformat (input, "drop"))
328 dpo_copy (dpo, drop_dpo_get (proto));
329 else if (unformat (input, "punt"))
330 dpo_copy (dpo, punt_dpo_get (proto));
331 else if (unformat (input, "local"))
332 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
333 else if (unformat (input, "null-send-unreach"))
334 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
335 else if (unformat (input, "null-send-prohibit"))
336 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
337 else if (unformat (input, "null"))
338 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
339 else if (unformat (input, "classify"))
341 u32 classify_table_index;
343 if (!unformat (input, "%d", &classify_table_index))
345 clib_warning ("classify adj must specify table index");
349 dpo_set (dpo, DPO_CLASSIFY, proto,
350 classify_dpo_create (proto, classify_table_index));
358 const ip46_address_t zero_addr = {
364 vnet_ip_route_cmd (vlib_main_t * vm,
365 unformat_input_t * main_input, vlib_cli_command_t * cmd)
367 unformat_input_t _line_input, *line_input = &_line_input;
368 fib_route_path_t *rpaths = NULL, rpath;
369 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
370 fib_prefix_t *prefixs = NULL, pfx;
371 mpls_label_t out_label, via_label;
372 clib_error_t *error = NULL;
373 u32 weight, preference;
374 u32 table_id, is_del;
380 vnm = vnet_get_main ();
384 memset (&pfx, 0, sizeof (pfx));
385 out_label = via_label = MPLS_LABEL_INVALID;
387 /* Get a line of input. */
388 if (!unformat_user (main_input, unformat_line_input, line_input))
391 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
393 memset (&rpath, 0, sizeof (rpath));
395 if (unformat (line_input, "table %d", &table_id))
397 else if (unformat (line_input, "resolve-via-host"))
399 if (vec_len (rpaths) == 0)
401 error = clib_error_return (0, "Paths then flags");
404 rpaths[vec_len (rpaths) - 1].frp_flags |=
405 FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
407 else if (unformat (line_input, "resolve-via-attached"))
409 if (vec_len (rpaths) == 0)
411 error = clib_error_return (0, "Paths then flags");
414 rpaths[vec_len (rpaths) - 1].frp_flags |=
415 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
417 else if (unformat (line_input, "out-labels"))
419 if (vec_len (rpaths) == 0)
421 error = clib_error_return (0, "Paths then labels");
426 while (unformat (line_input, "%U",
427 unformat_mpls_unicast_label, &out_label))
429 vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack,
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_eos = MPLS_NON_EOS;
439 rpath.frp_proto = DPO_PROTO_MPLS;
440 rpath.frp_sw_if_index = ~0;
441 vec_add1 (rpaths, rpath);
443 else if (unformat (line_input, "count %f", &count))
446 else if (unformat (line_input, "%U/%d",
447 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
449 pfx.fp_proto = FIB_PROTOCOL_IP4;
450 vec_add1 (prefixs, pfx);
452 else if (unformat (line_input, "%U/%d",
453 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
455 pfx.fp_proto = FIB_PROTOCOL_IP6;
456 vec_add1 (prefixs, pfx);
458 else if (unformat (line_input, "via %U %U",
459 unformat_ip4_address,
461 unformat_vnet_sw_interface, vnm,
462 &rpath.frp_sw_if_index))
464 rpath.frp_weight = 1;
465 rpath.frp_proto = DPO_PROTO_IP4;
466 vec_add1 (rpaths, rpath);
469 else if (unformat (line_input, "via %U %U",
470 unformat_ip6_address,
472 unformat_vnet_sw_interface, vnm,
473 &rpath.frp_sw_if_index))
475 rpath.frp_weight = 1;
476 rpath.frp_proto = DPO_PROTO_IP6;
477 vec_add1 (rpaths, rpath);
479 else if (unformat (line_input, "weight %u", &weight))
481 ASSERT (vec_len (rpaths));
482 rpaths[vec_len (rpaths) - 1].frp_weight = weight;
484 else if (unformat (line_input, "preference %u", &preference))
486 ASSERT (vec_len (rpaths));
487 rpaths[vec_len (rpaths) - 1].frp_preference = preference;
489 else if (unformat (line_input, "via %U next-hop-table %d",
490 unformat_ip4_address,
491 &rpath.frp_addr.ip4, &rpath.frp_fib_index))
493 rpath.frp_weight = 1;
494 rpath.frp_sw_if_index = ~0;
495 rpath.frp_proto = DPO_PROTO_IP4;
496 vec_add1 (rpaths, rpath);
498 else if (unformat (line_input, "via %U next-hop-table %d",
499 unformat_ip6_address,
500 &rpath.frp_addr.ip6, &rpath.frp_fib_index))
502 rpath.frp_weight = 1;
503 rpath.frp_sw_if_index = ~0;
504 rpath.frp_proto = DPO_PROTO_IP6;
505 vec_add1 (rpaths, rpath);
507 else if (unformat (line_input, "via %U",
508 unformat_ip4_address, &rpath.frp_addr.ip4))
511 * the recursive next-hops are by default in the same table
514 rpath.frp_fib_index = table_id;
515 rpath.frp_weight = 1;
516 rpath.frp_sw_if_index = ~0;
517 rpath.frp_proto = DPO_PROTO_IP4;
518 vec_add1 (rpaths, rpath);
520 else if (unformat (line_input, "via %U",
521 unformat_ip6_address, &rpath.frp_addr.ip6))
523 rpath.frp_fib_index = table_id;
524 rpath.frp_weight = 1;
525 rpath.frp_sw_if_index = ~0;
526 rpath.frp_proto = DPO_PROTO_IP6;
527 vec_add1 (rpaths, rpath);
529 else if (unformat (line_input,
530 "lookup in table %d", &rpath.frp_fib_index))
532 rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
533 rpath.frp_sw_if_index = ~0;
534 vec_add1 (rpaths, rpath);
536 else if (vec_len (prefixs) > 0 &&
537 unformat (line_input, "via %U",
538 unformat_vnet_sw_interface, vnm,
539 &rpath.frp_sw_if_index))
541 rpath.frp_weight = 1;
542 rpath.frp_proto = fib_proto_to_dpo (prefixs[0].fp_proto);
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);
551 else if (unformat (line_input, "del"))
553 else if (unformat (line_input, "add"))
557 error = unformat_parse_error (line_input);
562 if (vec_len (prefixs) == 0)
565 clib_error_return (0, "expected ip4/ip6 destination address/length.");
569 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
571 error = clib_error_return (0, "expected paths.");
578 * if no table_id is passed we will manipulate the default
584 fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
588 error = clib_error_return (0, "Nonexistent table id %d", table_id);
593 for (i = 0; i < vec_len (prefixs); i++)
595 if (is_del && 0 == vec_len (rpaths))
597 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
599 else if (!is_del && 1 == vec_len (dpos))
601 fib_table_entry_special_dpo_add (fib_index,
604 FIB_ENTRY_FLAG_EXCLUSIVE,
606 dpo_reset (&dpos[0]);
608 else if (vec_len (dpos) > 0)
611 clib_error_return (0,
612 "Load-balancing over multiple special adjacencies is unsupported");
615 else if (0 < vec_len (rpaths))
618 ip46_address_t dst = prefixs[i].fp_addr;
621 t[0] = vlib_time_now (vm);
622 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
625 for (k = 0; k < n; k++)
627 for (j = 0; j < vec_len (rpaths); j++)
631 * the CLI parsing stored table Ids, swap to FIB indicies
633 fi = fib_table_find (prefixs[i].fp_proto,
634 rpaths[i].frp_fib_index);
639 clib_error_return (0, "Via table %d does not exist",
640 rpaths[i].frp_fib_index);
643 rpaths[i].frp_fib_index = fi;
645 fib_prefix_t rpfx = {
646 .fp_len = prefixs[i].fp_len,
647 .fp_proto = prefixs[i].fp_proto,
652 fib_table_entry_path_remove2 (fib_index,
654 FIB_SOURCE_CLI, &rpaths[j]);
656 fib_table_entry_path_add2 (fib_index,
663 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
666 clib_host_to_net_u32 (incr +
667 clib_net_to_host_u32 (dst.
672 int bucket = (incr < 64 ? 0 : 1);
673 dst.ip6.as_u64[bucket] =
674 clib_host_to_net_u64 (incr +
675 clib_net_to_host_u64 (dst.ip6.as_u64
680 t[1] = vlib_time_now (vm);
682 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
686 error = clib_error_return (0, "Don't understand what you want...");
696 unformat_free (line_input);
701 vnet_ip_table_cmd (vlib_main_t * vm,
702 unformat_input_t * main_input,
703 vlib_cli_command_t * cmd, fib_protocol_t fproto)
705 unformat_input_t _line_input, *line_input = &_line_input;
706 clib_error_t *error = NULL;
707 u32 table_id, is_add;
713 /* Get a line of input. */
714 if (!unformat_user (main_input, unformat_line_input, line_input))
717 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
719 if (unformat (line_input, "%d", &table_id))
721 else if (unformat (line_input, "del"))
723 else if (unformat (line_input, "add"))
725 else if (unformat (line_input, "name %s", &name))
729 error = unformat_parse_error (line_input);
736 error = clib_error_return (0, "No table id");
739 else if (0 == table_id)
741 error = clib_error_return (0, "Can't change the default table");
748 ip_table_create (fproto, table_id, 0, name);
752 ip_table_delete (fproto, table_id, 0);
757 unformat_free (line_input);
762 vnet_ip4_table_cmd (vlib_main_t * vm,
763 unformat_input_t * main_input, vlib_cli_command_t * cmd)
765 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
769 vnet_ip6_table_cmd (vlib_main_t * vm,
770 unformat_input_t * main_input, vlib_cli_command_t * cmd)
772 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
776 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
778 .short_help = "Internet protocol (IP) commands",
783 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
785 .short_help = "Internet protocol version 6 (IPv6) commands",
790 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
792 .short_help = "Internet protocol (IP) show commands",
797 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
799 .short_help = "Internet protocol version 6 (IPv6) show commands",
804 * This command is used to add or delete IPv4 or IPv6 routes. All
805 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
806 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
807 * can be IPv4 or IPv6, but all must be of the same form in a single
808 * command. To display the current set of routes, use the commands
809 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
812 * Example of how to add a straight forward static route:
813 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
814 * Example of how to delete a straight forward static route:
815 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
816 * Mainly for route add/del performance testing, one can add or delete
817 * multiple routes by adding 'count N' to the previous item:
818 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
819 * Add multiple routes for the same destination to create equal-cost multipath:
820 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
821 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
822 * For unequal-cost multipath, specify the desired weights. This
823 * combination of weights results in 3/4 of the traffic following the
824 * second path, 1/4 following the first path:
825 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
826 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
827 * To add a route to a particular FIB table (VRF), use:
828 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
831 VLIB_CLI_COMMAND (ip_route_command, static) = {
833 .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>]",
834 .function = vnet_ip_route_cmd,
840 * This command is used to add or delete IPv4 Tables. All
841 * Tables must be explicitly added before that can be used. Creating a
842 * table will add both unicast and multicast FIBs
846 VLIB_CLI_COMMAND (ip4_table_command, static) = {
848 .short_help = "ip table [add|del] <table-id>",
849 .function = vnet_ip4_table_cmd,
856 * This command is used to add or delete IPv4 Tables. All
857 * Tables must be explicitly added before that can be used. Creating a
858 * table will add both unicast and multicast FIBs
862 VLIB_CLI_COMMAND (ip6_table_command, static) = {
864 .short_help = "ip6 table [add|del] <table-id>",
865 .function = vnet_ip6_table_cmd,
869 static clib_error_t *
870 ip_table_bind_cmd (vlib_main_t * vm,
871 unformat_input_t * input,
872 vlib_cli_command_t * cmd,
873 fib_protocol_t fproto)
875 vnet_main_t *vnm = vnet_get_main ();
876 clib_error_t *error = 0;
877 u32 sw_if_index, table_id;
882 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
884 error = clib_error_return (0, "unknown interface `%U'",
885 format_unformat_error, input);
889 if (unformat (input, "%d", &table_id))
893 error = clib_error_return (0, "expected table id `%U'",
894 format_unformat_error, input);
898 rv = ip_table_bind (fproto, sw_if_index, table_id, 0);
900 if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
902 error = clib_error_return (0, "IP addresses are still present on %U",
903 format_vnet_sw_if_index_name,
907 else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
909 error = clib_error_return (0, "no such table %d", table_id);
913 error = clib_error_return (0, "unknown error");
920 static clib_error_t *
921 ip4_table_bind_cmd (vlib_main_t * vm,
922 unformat_input_t * input,
923 vlib_cli_command_t * cmd)
925 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP4));
928 static clib_error_t *
929 ip6_table_bind_cmd (vlib_main_t * vm,
930 unformat_input_t * input,
931 vlib_cli_command_t * cmd)
933 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
937 * Place the indicated interface into the supplied IPv4 FIB table (also known
938 * as a VRF). If the FIB table does not exist, this command creates it. To
939 * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
940 * FIB table will only be displayed if a route has been added to the table, or
941 * an IP Address is assigned to an interface in the table (which adds a route
944 * @note IP addresses added after setting the interface IP table are added to
945 * the indicated FIB table. If an IP address is added prior to changing the
946 * table then this is an error. The control plane must remove these addresses
947 * first and then change the table. VPP will not automatically move the
948 * addresses from the old to the new table as it does not know the validity
952 * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
953 * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
956 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
958 .path = "set interface ip table",
959 .function = ip4_table_bind_cmd,
960 .short_help = "set interface ip table <interface> <table-id>",
965 * Place the indicated interface into the supplied IPv6 FIB table (also known
966 * as a VRF). If the FIB table does not exist, this command creates it. To
967 * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
968 * FIB table will only be displayed if a route has been added to the table, or
969 * an IP Address is assigned to an interface in the table (which adds a route
972 * @note IP addresses added after setting the interface IP table are added to
973 * the indicated FIB table. If an IP address is added prior to changing the
974 * table then this is an error. The control plane must remove these addresses
975 * first and then change the table. VPP will not automatically move the
976 * addresses from the old to the new table as it does not know the validity
980 * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
981 * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
984 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
986 .path = "set interface ip6 table",
987 .function = ip6_table_bind_cmd,
988 .short_help = "set interface ip6 table <interface> <table-id>"
993 vnet_ip_mroute_cmd (vlib_main_t * vm,
994 unformat_input_t * main_input, vlib_cli_command_t * cmd)
996 unformat_input_t _line_input, *line_input = &_line_input;
997 clib_error_t *error = NULL;
998 fib_route_path_t rpath;
999 u32 table_id, is_del;
1003 mfib_itf_flags_t iflags = 0;
1004 mfib_entry_flags_t eflags = 0;
1005 u32 gcount, scount, ss, gg, incr;
1008 gcount = scount = 1;
1009 vnm = vnet_get_main ();
1012 memset (&pfx, 0, sizeof (pfx));
1013 memset (&rpath, 0, sizeof (rpath));
1014 rpath.frp_sw_if_index = ~0;
1016 /* Get a line of input. */
1017 if (!unformat_user (main_input, unformat_line_input, line_input))
1020 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1022 if (unformat (line_input, "table %d", &table_id))
1024 else if (unformat (line_input, "del"))
1026 else if (unformat (line_input, "add"))
1028 else if (unformat (line_input, "scount %d", &scount))
1030 else if (unformat (line_input, "gcount %d", &gcount))
1032 else if (unformat (line_input, "%U %U",
1033 unformat_ip4_address,
1034 &pfx.fp_src_addr.ip4,
1035 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1037 pfx.fp_proto = FIB_PROTOCOL_IP4;
1040 else if (unformat (line_input, "%U %U",
1041 unformat_ip6_address,
1042 &pfx.fp_src_addr.ip6,
1043 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1045 pfx.fp_proto = FIB_PROTOCOL_IP6;
1048 else if (unformat (line_input, "%U/%d",
1049 unformat_ip4_address,
1050 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
1052 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1053 pfx.fp_proto = FIB_PROTOCOL_IP4;
1055 else if (unformat (line_input, "%U/%d",
1056 unformat_ip6_address,
1057 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
1059 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1060 pfx.fp_proto = FIB_PROTOCOL_IP6;
1062 else if (unformat (line_input, "%U",
1063 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1065 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1066 pfx.fp_proto = FIB_PROTOCOL_IP4;
1069 else if (unformat (line_input, "%U",
1070 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1072 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1073 pfx.fp_proto = FIB_PROTOCOL_IP6;
1076 else if (unformat (line_input, "via %U",
1077 unformat_vnet_sw_interface, vnm,
1078 &rpath.frp_sw_if_index))
1080 rpath.frp_weight = 1;
1082 else if (unformat (line_input, "via local"))
1084 rpath.frp_sw_if_index = ~0;
1085 rpath.frp_weight = 1;
1086 rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
1088 else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
1090 else if (unformat (line_input, "%U",
1091 unformat_mfib_entry_flags, &eflags))
1095 error = unformat_parse_error (line_input);
1103 * if no table_id is passed we will manipulate the default
1109 fib_index = mfib_table_find (pfx.fp_proto, table_id);
1111 if (~0 == fib_index)
1113 error = clib_error_return (0, "Nonexistent table id %d", table_id);
1118 timet[0] = vlib_time_now (vm);
1120 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1122 incr = 1 << (32 - (pfx.fp_len % 32));
1126 incr = 1 << (128 - (pfx.fp_len % 128));
1129 for (ss = 0; ss < scount; ss++)
1131 for (gg = 0; gg < gcount; gg++)
1133 if (is_del && 0 == rpath.frp_weight)
1135 /* no path provided => route delete */
1136 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
1140 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
1141 MFIB_RPF_ID_NONE, eflags);
1146 mfib_table_entry_path_remove (fib_index,
1147 &pfx, MFIB_SOURCE_CLI, &rpath);
1149 mfib_table_entry_path_update (fib_index,
1150 &pfx, MFIB_SOURCE_CLI, &rpath,
1154 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1156 pfx.fp_grp_addr.ip4.as_u32 =
1157 clib_host_to_net_u32 (incr +
1158 clib_net_to_host_u32 (pfx.
1164 int bucket = (incr < 64 ? 0 : 1);
1165 pfx.fp_grp_addr.ip6.as_u64[bucket] =
1166 clib_host_to_net_u64 (incr +
1167 clib_net_to_host_u64 (pfx.
1168 fp_grp_addr.ip6.as_u64
1173 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1175 pfx.fp_src_addr.ip4.as_u32 =
1176 clib_host_to_net_u32 (1 +
1177 clib_net_to_host_u32 (pfx.fp_src_addr.
1182 pfx.fp_src_addr.ip6.as_u64[1] =
1183 clib_host_to_net_u64 (1 +
1184 clib_net_to_host_u64 (pfx.fp_src_addr.
1189 timet[1] = vlib_time_now (vm);
1191 if (scount > 1 || gcount > 1)
1192 vlib_cli_output (vm, "%.6e routes/sec",
1193 (scount * gcount) / (timet[1] - timet[0]));
1196 unformat_free (line_input);
1202 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
1203 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
1204 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
1205 * can be IPv4 or IPv6, but all must be of the same form in a single
1206 * command. To display the current set of routes, use the commands
1207 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
1208 * The full set of support flags for interfaces and route is shown via;
1209 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
1212 * Example of how to add a forwarding interface to a route (and create the
1213 * route if it does not exist)
1214 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1215 * Example of how to add an accepting interface to a route (and create the
1216 * route if it does not exist)
1217 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1218 * Example of changing the route's flags to send signals via the API
1219 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1223 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1225 .path = "ip mroute",
1226 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1227 .function = vnet_ip_mroute_cmd,
1233 * The next two routines address a longstanding script hemorrhoid.
1234 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1235 * or dependent route-adds will simply fail.
1237 static clib_error_t *
1238 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1241 vnet_main_t *vnm = vnet_get_main ();
1246 uword *event_data = 0;
1248 ASSERT (vlib_in_process_context (vm));
1250 if (retry_count > 0)
1251 vnet_register_ip6_neighbor_resolution_event
1252 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1253 1 /* event */ , 0 /* data */ );
1255 for (i = 0; i < retry_count; i++)
1257 /* The interface may be down, etc. */
1258 e = ip6_probe_neighbor (vm, a, sw_if_index);
1263 vlib_process_wait_for_event_or_clock (vm, 1.0);
1264 event_type = vlib_process_get_events (vm, &event_data);
1267 case 1: /* resolved... */
1268 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1272 case ~0: /* timeout */
1276 clib_warning ("unknown event_type %d", event_type);
1278 vec_reset_length (event_data);
1284 return clib_error_return (0, "Resolution failed for %U",
1285 format_ip6_address, a);
1289 static clib_error_t *
1290 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1293 vnet_main_t *vnm = vnet_get_main ();
1298 uword *event_data = 0;
1300 ASSERT (vlib_in_process_context (vm));
1302 if (retry_count > 0)
1303 vnet_register_ip4_arp_resolution_event
1304 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1305 1 /* event */ , 0 /* data */ );
1307 for (i = 0; i < retry_count; i++)
1309 /* The interface may be down, etc. */
1310 e = ip4_probe_neighbor (vm, a, sw_if_index);
1315 vlib_process_wait_for_event_or_clock (vm, 1.0);
1316 event_type = vlib_process_get_events (vm, &event_data);
1319 case 1: /* resolved... */
1320 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1324 case ~0: /* timeout */
1328 clib_warning ("unknown event_type %d", event_type);
1330 vec_reset_length (event_data);
1335 vec_reset_length (event_data);
1338 return clib_error_return (0, "Resolution failed for %U",
1339 format_ip4_address, a);
1343 static clib_error_t *
1344 probe_neighbor_address (vlib_main_t * vm,
1345 unformat_input_t * input, vlib_cli_command_t * cmd)
1347 vnet_main_t *vnm = vnet_get_main ();
1348 unformat_input_t _line_input, *line_input = &_line_input;
1351 clib_error_t *error = 0;
1352 u32 sw_if_index = ~0;
1353 int retry_count = 3;
1355 int address_set = 0;
1357 /* Get a line of input. */
1358 if (!unformat_user (input, unformat_line_input, line_input))
1361 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1363 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1366 else if (unformat (line_input, "retry %d", &retry_count))
1369 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1371 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1378 error = clib_error_return (0, "unknown input '%U'",
1379 format_unformat_error, line_input);
1384 if (sw_if_index == ~0)
1386 error = clib_error_return (0, "Interface required, not set.");
1389 if (address_set == 0)
1391 error = clib_error_return (0, "ip address required, not set.");
1394 if (address_set > 1)
1396 error = clib_error_return (0, "Multiple ip addresses not supported.");
1401 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1403 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1406 unformat_free (line_input);
1412 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1413 * attempts IPv6 neighbor discovery depending on the supplied IP address
1416 * @note This command will not immediately affect the indicated FIB; it
1417 * is not suitable for use in establishing a FIB entry prior to adding
1418 * recursive FIB entries. As in: don't use it in a script to probe a
1419 * gateway prior to adding a default route. It won't work. Instead,
1420 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1421 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1424 * Example of probe for an IPv4 address:
1425 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1428 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1429 .path = "ip probe-neighbor",
1430 .function = probe_neighbor_address,
1431 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1437 * fd.io coding-style-patch-verification: ON
1440 * eval: (c-set-style "gnu")