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/dpo/l3_proxy_dpo.h>
53 #include <vnet/ip/ip6_neighbor.h>
57 * @brief IPv4 and IPv6 adjacency and lookup table managment.
62 ip_interface_address_add_del (ip_lookup_main_t * lm,
66 u32 is_del, u32 * result_if_address_index)
68 vnet_main_t *vnm = vnet_get_main ();
69 ip_interface_address_t *a, *prev, *next;
70 uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
72 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
74 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
76 /* Verify given length. */
77 if ((a && (address_length != a->address_length)) ||
78 (address_length == 0) ||
79 (lm->is_ip6 && address_length > 128) ||
80 (!lm->is_ip6 && address_length > 32))
82 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
83 return clib_error_create
84 ("%U wrong length (expected %d) for interface %U",
85 lm->format_address_and_length, addr_fib,
86 address_length, a ? a->address_length : -1,
87 format_vnet_sw_if_index_name, vnm, sw_if_index);
94 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
95 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
96 return clib_error_create ("%U not found for interface %U",
97 lm->format_address_and_length,
98 addr_fib, address_length,
99 format_vnet_sw_interface_name, vnm, si);
102 if (a->prev_this_sw_interface != ~0)
105 pool_elt_at_index (lm->if_address_pool,
106 a->prev_this_sw_interface);
107 prev->next_this_sw_interface = a->next_this_sw_interface;
109 if (a->next_this_sw_interface != ~0)
112 pool_elt_at_index (lm->if_address_pool,
113 a->next_this_sw_interface);
114 next->prev_this_sw_interface = a->prev_this_sw_interface;
116 if (a->prev_this_sw_interface == ~0)
117 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
118 a->next_this_sw_interface;
121 if ((a->next_this_sw_interface == ~0)
122 && (a->prev_this_sw_interface == ~0))
123 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
125 mhash_unset (&lm->address_to_if_address_index, addr_fib,
127 pool_put (lm->if_address_pool, a);
129 if (result_if_address_index)
130 *result_if_address_index = ~0;
135 u32 pi; /* previous index */
137 u32 hi; /* head index */
139 pool_get (lm->if_address_pool, a);
140 memset (a, ~0, sizeof (a[0]));
141 ai = a - lm->if_address_pool;
143 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
145 while (pi != (u32) ~ 0)
147 prev = pool_elt_at_index (lm->if_address_pool, pi);
148 pi = prev->next_this_sw_interface;
150 pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
152 a->address_key = mhash_set (&lm->address_to_if_address_index,
153 addr_fib, ai, /* old_value */ 0);
154 a->address_length = address_length;
155 a->sw_if_index = sw_if_index;
157 a->prev_this_sw_interface = pi;
158 a->next_this_sw_interface = ~0;
160 prev->next_this_sw_interface = ai;
162 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
163 (hi != ~0) ? hi : ai;
164 if (result_if_address_index)
165 *result_if_address_index = ai;
169 if (sw_if_index != a->sw_if_index)
171 if (result_if_address_index)
172 *result_if_address_index = ~0;
173 vnm->api_errno = VNET_API_ERROR_DUPLICATE_IF_ADDRESS;
174 return clib_error_create
175 ("Prefix %U already found on interface %U",
176 lm->format_address_and_length, addr_fib, address_length,
177 format_vnet_sw_if_index_name, vnm, a->sw_if_index);
180 if (result_if_address_index)
181 *result_if_address_index = a - lm->if_address_pool;
184 return /* no error */ 0;
187 static clib_error_t *
188 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
190 vec_validate_init_empty (ip4_main.
191 lookup_main.if_address_pool_index_by_sw_if_index,
193 vec_validate_init_empty (ip6_main.
194 lookup_main.if_address_pool_index_by_sw_if_index,
200 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
203 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
205 if (!lm->fib_result_n_bytes)
206 lm->fib_result_n_bytes = sizeof (uword);
211 lm->format_address_and_length = format_ip6_address_and_length;
212 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
213 sizeof (ip6_address_fib_t));
217 lm->format_address_and_length = format_ip4_address_and_length;
218 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
219 sizeof (ip4_address_fib_t));
225 /* Setup all IP protocols to be punted and builtin-unknown. */
226 for (i = 0; i < 256; i++)
228 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
229 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
232 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
233 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
234 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
235 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
236 IP_BUILTIN_PROTOCOL_UDP;
237 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
239 IP_BUILTIN_PROTOCOL_ICMP;
244 format_ip_flow_hash_config (u8 * s, va_list * args)
246 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
248 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
249 foreach_flow_hash_bit;
256 format_ip_lookup_next (u8 * s, va_list * args)
258 /* int promotion of ip_lookup_next_t */
259 ip_lookup_next_t n = va_arg (*args, int);
265 s = format (s, "unknown %d", n);
268 case IP_LOOKUP_NEXT_DROP:
271 case IP_LOOKUP_NEXT_PUNT:
274 case IP_LOOKUP_NEXT_ARP:
277 case IP_LOOKUP_NEXT_MIDCHAIN:
280 case IP_LOOKUP_NEXT_GLEAN:
283 case IP_LOOKUP_NEXT_MCAST:
286 case IP_LOOKUP_NEXT_REWRITE:
291 vec_add (s, t, strlen (t));
297 format_ip_adjacency_packet_data (u8 * s, va_list * args)
299 u32 adj_index = va_arg (*args, u32);
300 u8 *packet_data = va_arg (*args, u8 *);
301 u32 n_packet_data_bytes = va_arg (*args, u32);
302 ip_adjacency_t *adj = adj_get (adj_index);
304 switch (adj->lookup_next_index)
306 case IP_LOOKUP_NEXT_REWRITE:
307 case IP_LOOKUP_NEXT_MCAST:
309 format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
320 unformat_dpo (unformat_input_t * input, va_list * args)
322 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
323 fib_protocol_t fp = va_arg (*args, int);
326 proto = fib_proto_to_dpo (fp);
328 if (unformat (input, "drop"))
329 dpo_copy (dpo, drop_dpo_get (proto));
330 else if (unformat (input, "punt"))
331 dpo_copy (dpo, punt_dpo_get (proto));
332 else if (unformat (input, "local"))
333 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
334 else if (unformat (input, "null-send-unreach"))
335 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
336 else if (unformat (input, "null-send-prohibit"))
337 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
338 else if (unformat (input, "null"))
339 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
340 else if (unformat (input, "classify"))
342 u32 classify_table_index;
344 if (!unformat (input, "%d", &classify_table_index))
346 clib_warning ("classify adj must specify table index");
350 dpo_set (dpo, DPO_CLASSIFY, proto,
351 classify_dpo_create (proto, classify_table_index));
359 const ip46_address_t zero_addr = {
365 vnet_ip_route_cmd (vlib_main_t * vm,
366 unformat_input_t * main_input, vlib_cli_command_t * cmd)
368 unformat_input_t _line_input, *line_input = &_line_input;
369 fib_route_path_t *rpaths = NULL, rpath;
370 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
371 u32 table_id, is_del, udp_encap_id;
372 fib_prefix_t *prefixs = NULL, pfx;
373 mpls_label_t out_label, via_label;
374 clib_error_t *error = NULL;
375 u32 weight, preference;
381 vnm = vnet_get_main ();
385 memset (&pfx, 0, sizeof (pfx));
386 out_label = via_label = MPLS_LABEL_INVALID;
388 /* Get a line of input. */
389 if (!unformat_user (main_input, unformat_line_input, line_input))
392 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
394 memset (&rpath, 0, sizeof (rpath));
396 if (unformat (line_input, "table %d", &table_id))
398 else if (unformat (line_input, "resolve-via-host"))
400 if (vec_len (rpaths) == 0)
402 error = clib_error_return (0, "Paths then flags");
405 rpaths[vec_len (rpaths) - 1].frp_flags |=
406 FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
408 else if (unformat (line_input, "resolve-via-attached"))
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_ATTACHED;
418 else if (unformat (line_input, "out-labels"))
420 if (vec_len (rpaths) == 0)
422 error = clib_error_return (0, "Paths then labels");
427 while (unformat (line_input, "%U",
428 unformat_mpls_unicast_label, &out_label))
430 vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack,
435 else if (unformat (line_input, "via-label %U",
436 unformat_mpls_unicast_label, &rpath.frp_local_label))
438 rpath.frp_weight = 1;
439 rpath.frp_eos = MPLS_NON_EOS;
440 rpath.frp_proto = DPO_PROTO_MPLS;
441 rpath.frp_sw_if_index = ~0;
442 vec_add1 (rpaths, rpath);
444 else if (unformat (line_input, "count %f", &count))
447 else if (unformat (line_input, "%U/%d",
448 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
450 pfx.fp_proto = FIB_PROTOCOL_IP4;
451 vec_add1 (prefixs, pfx);
453 else if (unformat (line_input, "%U/%d",
454 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
456 pfx.fp_proto = FIB_PROTOCOL_IP6;
457 vec_add1 (prefixs, pfx);
459 else if (unformat (line_input, "via %U %U",
460 unformat_ip4_address,
462 unformat_vnet_sw_interface, vnm,
463 &rpath.frp_sw_if_index))
465 rpath.frp_weight = 1;
466 rpath.frp_proto = DPO_PROTO_IP4;
467 vec_add1 (rpaths, rpath);
470 else if (unformat (line_input, "via %U %U",
471 unformat_ip6_address,
473 unformat_vnet_sw_interface, vnm,
474 &rpath.frp_sw_if_index))
476 rpath.frp_weight = 1;
477 rpath.frp_proto = DPO_PROTO_IP6;
478 vec_add1 (rpaths, rpath);
480 else if (unformat (line_input, "weight %u", &weight))
482 ASSERT (vec_len (rpaths));
483 rpaths[vec_len (rpaths) - 1].frp_weight = weight;
485 else if (unformat (line_input, "preference %u", &preference))
487 ASSERT (vec_len (rpaths));
488 rpaths[vec_len (rpaths) - 1].frp_preference = preference;
490 else if (unformat (line_input, "via %U next-hop-table %d",
491 unformat_ip4_address,
492 &rpath.frp_addr.ip4, &rpath.frp_fib_index))
494 rpath.frp_weight = 1;
495 rpath.frp_sw_if_index = ~0;
496 rpath.frp_proto = DPO_PROTO_IP4;
497 vec_add1 (rpaths, rpath);
499 else if (unformat (line_input, "via %U next-hop-table %d",
500 unformat_ip6_address,
501 &rpath.frp_addr.ip6, &rpath.frp_fib_index))
503 rpath.frp_weight = 1;
504 rpath.frp_sw_if_index = ~0;
505 rpath.frp_proto = DPO_PROTO_IP6;
506 vec_add1 (rpaths, rpath);
508 else if (unformat (line_input, "via %U",
509 unformat_ip4_address, &rpath.frp_addr.ip4))
512 * the recursive next-hops are by default in the same table
515 rpath.frp_fib_index = table_id;
516 rpath.frp_weight = 1;
517 rpath.frp_sw_if_index = ~0;
518 rpath.frp_proto = DPO_PROTO_IP4;
519 vec_add1 (rpaths, rpath);
521 else if (unformat (line_input, "via %U",
522 unformat_ip6_address, &rpath.frp_addr.ip6))
524 rpath.frp_fib_index = table_id;
525 rpath.frp_weight = 1;
526 rpath.frp_sw_if_index = ~0;
527 rpath.frp_proto = DPO_PROTO_IP6;
528 vec_add1 (rpaths, rpath);
530 else if (unformat (line_input, "via udp-encap %d", &udp_encap_id))
532 rpath.frp_udp_encap_id = udp_encap_id;
533 rpath.frp_flags |= FIB_ROUTE_PATH_UDP_ENCAP;
534 rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
535 vec_add1 (rpaths, rpath);
537 else if (unformat (line_input,
538 "lookup in table %d", &rpath.frp_fib_index))
540 rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
541 rpath.frp_sw_if_index = ~0;
542 vec_add1 (rpaths, rpath);
544 else if (vec_len (prefixs) > 0 &&
545 unformat (line_input, "via %U",
546 unformat_vnet_sw_interface, vnm,
547 &rpath.frp_sw_if_index))
549 rpath.frp_weight = 1;
550 rpath.frp_proto = fib_proto_to_dpo (prefixs[0].fp_proto);
551 vec_add1 (rpaths, rpath);
553 else if (vec_len (prefixs) > 0 &&
554 unformat (line_input, "via %U",
555 unformat_dpo, &dpo, prefixs[0].fp_proto))
557 vec_add1 (dpos, dpo);
559 else if (unformat (line_input, "del"))
561 else if (unformat (line_input, "add"))
565 error = unformat_parse_error (line_input);
570 if (vec_len (prefixs) == 0)
573 clib_error_return (0, "expected ip4/ip6 destination address/length.");
577 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
579 error = clib_error_return (0, "expected paths.");
586 * if no table_id is passed we will manipulate the default
592 fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
596 error = clib_error_return (0, "Nonexistent table id %d", table_id);
601 for (i = 0; i < vec_len (prefixs); i++)
603 if (is_del && 0 == vec_len (rpaths))
605 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
607 else if (!is_del && 1 == vec_len (dpos))
609 fib_table_entry_special_dpo_add (fib_index,
612 FIB_ENTRY_FLAG_EXCLUSIVE,
614 dpo_reset (&dpos[0]);
616 else if (vec_len (dpos) > 0)
619 clib_error_return (0,
620 "Load-balancing over multiple special adjacencies is unsupported");
623 else if (0 < vec_len (rpaths))
626 ip46_address_t dst = prefixs[i].fp_addr;
629 t[0] = vlib_time_now (vm);
630 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
633 for (k = 0; k < n; k++)
635 for (j = 0; j < vec_len (rpaths); j++)
639 * the CLI parsing stored table Ids, swap to FIB indicies
641 fi = fib_table_find (prefixs[i].fp_proto,
642 rpaths[i].frp_fib_index);
647 clib_error_return (0, "Via table %d does not exist",
648 rpaths[i].frp_fib_index);
651 rpaths[i].frp_fib_index = fi;
653 fib_prefix_t rpfx = {
654 .fp_len = prefixs[i].fp_len,
655 .fp_proto = prefixs[i].fp_proto,
660 fib_table_entry_path_remove2 (fib_index,
662 FIB_SOURCE_CLI, &rpaths[j]);
664 fib_table_entry_path_add2 (fib_index,
671 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
674 clib_host_to_net_u32 (incr +
675 clib_net_to_host_u32 (dst.
680 int bucket = (incr < 64 ? 0 : 1);
681 dst.ip6.as_u64[bucket] =
682 clib_host_to_net_u64 (incr +
683 clib_net_to_host_u64 (dst.ip6.as_u64
688 t[1] = vlib_time_now (vm);
690 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
694 error = clib_error_return (0, "Don't understand what you want...");
704 unformat_free (line_input);
709 vnet_ip_table_cmd (vlib_main_t * vm,
710 unformat_input_t * main_input,
711 vlib_cli_command_t * cmd, fib_protocol_t fproto)
713 unformat_input_t _line_input, *line_input = &_line_input;
714 clib_error_t *error = NULL;
715 u32 table_id, is_add;
721 /* Get a line of input. */
722 if (!unformat_user (main_input, unformat_line_input, line_input))
725 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
727 if (unformat (line_input, "%d", &table_id))
729 else if (unformat (line_input, "del"))
731 else if (unformat (line_input, "add"))
733 else if (unformat (line_input, "name %s", &name))
737 error = unformat_parse_error (line_input);
744 error = clib_error_return (0, "No table id");
747 else if (0 == table_id)
749 error = clib_error_return (0, "Can't change the default table");
756 ip_table_create (fproto, table_id, 0, name);
760 ip_table_delete (fproto, table_id, 0);
765 unformat_free (line_input);
770 vnet_ip4_table_cmd (vlib_main_t * vm,
771 unformat_input_t * main_input, vlib_cli_command_t * cmd)
773 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
777 vnet_ip6_table_cmd (vlib_main_t * vm,
778 unformat_input_t * main_input, vlib_cli_command_t * cmd)
780 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
784 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
786 .short_help = "Internet protocol (IP) commands",
791 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
793 .short_help = "Internet protocol version 6 (IPv6) commands",
798 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
800 .short_help = "Internet protocol (IP) show commands",
805 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
807 .short_help = "Internet protocol version 6 (IPv6) show commands",
812 * This command is used to add or delete IPv4 or IPv6 routes. All
813 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
814 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
815 * can be IPv4 or IPv6, but all must be of the same form in a single
816 * command. To display the current set of routes, use the commands
817 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
820 * Example of how to add a straight forward static route:
821 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
822 * Example of how to delete a straight forward static route:
823 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
824 * Mainly for route add/del performance testing, one can add or delete
825 * multiple routes by adding 'count N' to the previous item:
826 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
827 * Add multiple routes for the same destination to create equal-cost multipath:
828 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
829 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
830 * For unequal-cost multipath, specify the desired weights. This
831 * combination of weights results in 3/4 of the traffic following the
832 * second path, 1/4 following the first path:
833 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
834 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
835 * To add a route to a particular FIB table (VRF), use:
836 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
839 VLIB_CLI_COMMAND (ip_route_command, static) = {
841 .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>]",
842 .function = vnet_ip_route_cmd,
848 * This command is used to add or delete IPv4 Tables. All
849 * Tables must be explicitly added before that can be used. Creating a
850 * table will add both unicast and multicast FIBs
854 VLIB_CLI_COMMAND (ip4_table_command, static) = {
856 .short_help = "ip table [add|del] <table-id>",
857 .function = vnet_ip4_table_cmd,
864 * This command is used to add or delete IPv4 Tables. All
865 * Tables must be explicitly added before that can be used. Creating a
866 * table will add both unicast and multicast FIBs
870 VLIB_CLI_COMMAND (ip6_table_command, static) = {
872 .short_help = "ip6 table [add|del] <table-id>",
873 .function = vnet_ip6_table_cmd,
877 static clib_error_t *
878 ip_table_bind_cmd (vlib_main_t * vm,
879 unformat_input_t * input,
880 vlib_cli_command_t * cmd,
881 fib_protocol_t fproto)
883 vnet_main_t *vnm = vnet_get_main ();
884 clib_error_t *error = 0;
885 u32 sw_if_index, table_id;
890 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
892 error = clib_error_return (0, "unknown interface `%U'",
893 format_unformat_error, input);
897 if (unformat (input, "%d", &table_id))
901 error = clib_error_return (0, "expected table id `%U'",
902 format_unformat_error, input);
906 rv = ip_table_bind (fproto, sw_if_index, table_id, 0);
908 if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
910 error = clib_error_return (0, "IP addresses are still present on %U",
911 format_vnet_sw_if_index_name,
915 else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
917 error = clib_error_return (0, "no such table %d", table_id);
921 error = clib_error_return (0, "unknown error");
928 static clib_error_t *
929 ip4_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_IP4));
936 static clib_error_t *
937 ip6_table_bind_cmd (vlib_main_t * vm,
938 unformat_input_t * input,
939 vlib_cli_command_t * cmd)
941 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
945 * Place the indicated interface into the supplied IPv4 FIB table (also known
946 * as a VRF). If the FIB table does not exist, this command creates it. To
947 * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
948 * FIB table will only be displayed if a route has been added to the table, or
949 * an IP Address is assigned to an interface in the table (which adds a route
952 * @note IP addresses added after setting the interface IP table are added to
953 * the indicated FIB table. If an IP address is added prior to changing the
954 * table then this is an error. The control plane must remove these addresses
955 * first and then change the table. VPP will not automatically move the
956 * addresses from the old to the new table as it does not know the validity
960 * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
961 * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
964 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
966 .path = "set interface ip table",
967 .function = ip4_table_bind_cmd,
968 .short_help = "set interface ip table <interface> <table-id>",
973 * Place the indicated interface into the supplied IPv6 FIB table (also known
974 * as a VRF). If the FIB table does not exist, this command creates it. To
975 * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
976 * FIB table will only be displayed if a route has been added to the table, or
977 * an IP Address is assigned to an interface in the table (which adds a route
980 * @note IP addresses added after setting the interface IP table are added to
981 * the indicated FIB table. If an IP address is added prior to changing the
982 * table then this is an error. The control plane must remove these addresses
983 * first and then change the table. VPP will not automatically move the
984 * addresses from the old to the new table as it does not know the validity
988 * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
989 * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
992 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
994 .path = "set interface ip6 table",
995 .function = ip6_table_bind_cmd,
996 .short_help = "set interface ip6 table <interface> <table-id>"
1001 vnet_ip_mroute_cmd (vlib_main_t * vm,
1002 unformat_input_t * main_input, vlib_cli_command_t * cmd)
1004 unformat_input_t _line_input, *line_input = &_line_input;
1005 clib_error_t *error = NULL;
1006 fib_route_path_t rpath;
1007 u32 table_id, is_del;
1011 mfib_itf_flags_t iflags = 0;
1012 mfib_entry_flags_t eflags = 0;
1013 u32 gcount, scount, ss, gg, incr;
1016 gcount = scount = 1;
1017 vnm = vnet_get_main ();
1020 memset (&pfx, 0, sizeof (pfx));
1021 memset (&rpath, 0, sizeof (rpath));
1022 rpath.frp_sw_if_index = ~0;
1024 /* Get a line of input. */
1025 if (!unformat_user (main_input, unformat_line_input, line_input))
1028 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1030 if (unformat (line_input, "table %d", &table_id))
1032 else if (unformat (line_input, "del"))
1034 else if (unformat (line_input, "add"))
1036 else if (unformat (line_input, "scount %d", &scount))
1038 else if (unformat (line_input, "gcount %d", &gcount))
1040 else if (unformat (line_input, "%U %U",
1041 unformat_ip4_address,
1042 &pfx.fp_src_addr.ip4,
1043 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1045 pfx.fp_proto = FIB_PROTOCOL_IP4;
1048 else if (unformat (line_input, "%U %U",
1049 unformat_ip6_address,
1050 &pfx.fp_src_addr.ip6,
1051 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1053 pfx.fp_proto = FIB_PROTOCOL_IP6;
1056 else if (unformat (line_input, "%U/%d",
1057 unformat_ip4_address,
1058 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
1060 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1061 pfx.fp_proto = FIB_PROTOCOL_IP4;
1063 else if (unformat (line_input, "%U/%d",
1064 unformat_ip6_address,
1065 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
1067 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1068 pfx.fp_proto = FIB_PROTOCOL_IP6;
1070 else if (unformat (line_input, "%U",
1071 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1073 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1074 pfx.fp_proto = FIB_PROTOCOL_IP4;
1077 else if (unformat (line_input, "%U",
1078 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1080 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1081 pfx.fp_proto = FIB_PROTOCOL_IP6;
1084 else if (unformat (line_input, "via %U",
1085 unformat_vnet_sw_interface, vnm,
1086 &rpath.frp_sw_if_index))
1088 rpath.frp_weight = 1;
1090 else if (unformat (line_input, "via local"))
1092 rpath.frp_sw_if_index = ~0;
1093 rpath.frp_weight = 1;
1094 rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
1096 else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
1098 else if (unformat (line_input, "%U",
1099 unformat_mfib_entry_flags, &eflags))
1103 error = unformat_parse_error (line_input);
1111 * if no table_id is passed we will manipulate the default
1117 fib_index = mfib_table_find (pfx.fp_proto, table_id);
1119 if (~0 == fib_index)
1121 error = clib_error_return (0, "Nonexistent table id %d", table_id);
1126 timet[0] = vlib_time_now (vm);
1128 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1130 incr = 1 << (32 - (pfx.fp_len % 32));
1134 incr = 1 << (128 - (pfx.fp_len % 128));
1137 for (ss = 0; ss < scount; ss++)
1139 for (gg = 0; gg < gcount; gg++)
1141 if (is_del && 0 == rpath.frp_weight)
1143 /* no path provided => route delete */
1144 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
1148 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
1149 MFIB_RPF_ID_NONE, eflags);
1154 mfib_table_entry_path_remove (fib_index,
1155 &pfx, MFIB_SOURCE_CLI, &rpath);
1157 mfib_table_entry_path_update (fib_index,
1158 &pfx, MFIB_SOURCE_CLI, &rpath,
1162 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1164 pfx.fp_grp_addr.ip4.as_u32 =
1165 clib_host_to_net_u32 (incr +
1166 clib_net_to_host_u32 (pfx.
1172 int bucket = (incr < 64 ? 0 : 1);
1173 pfx.fp_grp_addr.ip6.as_u64[bucket] =
1174 clib_host_to_net_u64 (incr +
1175 clib_net_to_host_u64 (pfx.
1176 fp_grp_addr.ip6.as_u64
1181 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1183 pfx.fp_src_addr.ip4.as_u32 =
1184 clib_host_to_net_u32 (1 +
1185 clib_net_to_host_u32 (pfx.fp_src_addr.
1190 pfx.fp_src_addr.ip6.as_u64[1] =
1191 clib_host_to_net_u64 (1 +
1192 clib_net_to_host_u64 (pfx.fp_src_addr.
1197 timet[1] = vlib_time_now (vm);
1199 if (scount > 1 || gcount > 1)
1200 vlib_cli_output (vm, "%.6e routes/sec",
1201 (scount * gcount) / (timet[1] - timet[0]));
1204 unformat_free (line_input);
1210 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
1211 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
1212 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
1213 * can be IPv4 or IPv6, but all must be of the same form in a single
1214 * command. To display the current set of routes, use the commands
1215 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
1216 * The full set of support flags for interfaces and route is shown via;
1217 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
1220 * Example of how to add a forwarding interface to a route (and create the
1221 * route if it does not exist)
1222 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1223 * Example of how to add an accepting interface to a route (and create the
1224 * route if it does not exist)
1225 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1226 * Example of changing the route's flags to send signals via the API
1227 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1231 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1233 .path = "ip mroute",
1234 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1235 .function = vnet_ip_mroute_cmd,
1241 * The next two routines address a longstanding script hemorrhoid.
1242 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1243 * or dependent route-adds will simply fail.
1245 static clib_error_t *
1246 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1249 vnet_main_t *vnm = vnet_get_main ();
1254 uword *event_data = 0;
1256 ASSERT (vlib_in_process_context (vm));
1258 if (retry_count > 0)
1259 vnet_register_ip6_neighbor_resolution_event
1260 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1261 1 /* event */ , 0 /* data */ );
1263 for (i = 0; i < retry_count; i++)
1265 /* The interface may be down, etc. */
1266 e = ip6_probe_neighbor (vm, a, sw_if_index);
1271 vlib_process_wait_for_event_or_clock (vm, 1.0);
1272 event_type = vlib_process_get_events (vm, &event_data);
1275 case 1: /* resolved... */
1276 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1280 case ~0: /* timeout */
1284 clib_warning ("unknown event_type %d", event_type);
1286 vec_reset_length (event_data);
1292 return clib_error_return (0, "Resolution failed for %U",
1293 format_ip6_address, a);
1297 static clib_error_t *
1298 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1301 vnet_main_t *vnm = vnet_get_main ();
1306 uword *event_data = 0;
1308 ASSERT (vlib_in_process_context (vm));
1310 if (retry_count > 0)
1311 vnet_register_ip4_arp_resolution_event
1312 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1313 1 /* event */ , 0 /* data */ );
1315 for (i = 0; i < retry_count; i++)
1317 /* The interface may be down, etc. */
1318 e = ip4_probe_neighbor (vm, a, sw_if_index);
1323 vlib_process_wait_for_event_or_clock (vm, 1.0);
1324 event_type = vlib_process_get_events (vm, &event_data);
1327 case 1: /* resolved... */
1328 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1332 case ~0: /* timeout */
1336 clib_warning ("unknown event_type %d", event_type);
1338 vec_reset_length (event_data);
1343 vec_reset_length (event_data);
1346 return clib_error_return (0, "Resolution failed for %U",
1347 format_ip4_address, a);
1351 static clib_error_t *
1352 probe_neighbor_address (vlib_main_t * vm,
1353 unformat_input_t * input, vlib_cli_command_t * cmd)
1355 vnet_main_t *vnm = vnet_get_main ();
1356 unformat_input_t _line_input, *line_input = &_line_input;
1359 clib_error_t *error = 0;
1360 u32 sw_if_index = ~0;
1361 int retry_count = 3;
1363 int address_set = 0;
1365 /* Get a line of input. */
1366 if (!unformat_user (input, unformat_line_input, line_input))
1369 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1371 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1374 else if (unformat (line_input, "retry %d", &retry_count))
1377 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1379 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1386 error = clib_error_return (0, "unknown input '%U'",
1387 format_unformat_error, line_input);
1392 if (sw_if_index == ~0)
1394 error = clib_error_return (0, "Interface required, not set.");
1397 if (address_set == 0)
1399 error = clib_error_return (0, "ip address required, not set.");
1402 if (address_set > 1)
1404 error = clib_error_return (0, "Multiple ip addresses not supported.");
1409 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1411 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1414 unformat_free (line_input);
1420 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1421 * attempts IPv6 neighbor discovery depending on the supplied IP address
1424 * @note This command will not immediately affect the indicated FIB; it
1425 * is not suitable for use in establishing a FIB entry prior to adding
1426 * recursive FIB entries. As in: don't use it in a script to probe a
1427 * gateway prior to adding a default route. It won't work. Instead,
1428 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1429 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1432 * Example of probe for an IPv4 address:
1433 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1436 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1437 .path = "ip probe-neighbor",
1438 .function = probe_neighbor_address,
1439 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1445 vnet_ip_container_proxy_add_del (vnet_ip_container_proxy_args_t * args)
1449 if (!vnet_sw_interface_is_api_valid (vnet_get_main (), args->sw_if_index))
1450 return clib_error_return_code (0, VNET_API_ERROR_INVALID_INTERFACE, 0,
1451 "invalid sw_if_index");
1453 fib_index = fib_table_get_table_id_for_sw_if_index (args->prefix.fp_proto,
1457 dpo_id_t proxy_dpo = DPO_INVALID;
1458 l3_proxy_dpo_add_or_lock (fib_proto_to_dpo (args->prefix.fp_proto),
1459 args->sw_if_index, &proxy_dpo);
1460 fib_table_entry_special_dpo_add (fib_index,
1463 FIB_ENTRY_FLAG_EXCLUSIVE, &proxy_dpo);
1464 dpo_reset (&proxy_dpo);
1468 fib_table_entry_special_remove (fib_index, &args->prefix,
1475 ip_container_proxy_is_set (fib_prefix_t * pfx, u32 sw_if_index)
1478 fib_node_index_t fei;
1479 const dpo_id_t *dpo;
1480 l3_proxy_dpo_t *l3p;
1481 load_balance_t *lb0;
1483 fib_index = fib_table_get_table_id_for_sw_if_index (pfx->fp_proto,
1485 if (fib_index == ~0)
1488 fei = fib_table_lookup_exact_match (fib_index, pfx);
1489 if (fei == FIB_NODE_INDEX_INVALID)
1492 dpo = fib_entry_contribute_ip_forwarding (fei);
1493 lb0 = load_balance_get (dpo->dpoi_index);
1494 dpo = load_balance_get_bucket_i (lb0, 0);
1495 if (dpo->dpoi_type != DPO_L3_PROXY)
1498 l3p = l3_proxy_dpo_get (dpo->dpoi_index);
1499 return (l3p->l3p_sw_if_index == sw_if_index);
1503 ip_container_cmd (vlib_main_t * vm,
1504 unformat_input_t * main_input, vlib_cli_command_t * cmd)
1506 unformat_input_t _line_input, *line_input = &_line_input;
1513 vnm = vnet_get_main ();
1517 /* Get a line of input. */
1518 if (!unformat_user (main_input, unformat_line_input, line_input))
1521 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1523 if (unformat (line_input, "%U", unformat_ip4_address, &pfx.fp_addr.ip4))
1525 pfx.fp_proto = FIB_PROTOCOL_IP4;
1528 else if (unformat (line_input, "%U",
1529 unformat_ip6_address, &pfx.fp_addr.ip6))
1531 pfx.fp_proto = FIB_PROTOCOL_IP6;
1534 else if (unformat (line_input, "%U",
1535 unformat_vnet_sw_interface, vnm, &sw_if_index))
1537 else if (unformat (line_input, "del"))
1540 return (clib_error_return (0, "unknown input '%U'",
1541 format_unformat_error, line_input));
1544 if (~0 == sw_if_index)
1546 return (clib_error_return (0, "no interface"));
1549 vnet_ip_container_proxy_args_t args = {
1551 .sw_if_index = sw_if_index,
1554 vnet_ip_container_proxy_add_del (&args);
1555 unformat_free (line_input);
1560 VLIB_CLI_COMMAND (ip_container_command_node, static) = {
1561 .path = "ip container",
1562 .function = ip_container_cmd,
1563 .short_help = "ip container <address> <interface>",
1569 show_ip_container_cmd_fn (vlib_main_t * vm, unformat_input_t * main_input,
1570 vlib_cli_command_t * cmd)
1572 unformat_input_t _line_input, *line_input = &_line_input;
1573 vnet_main_t *vnm = vnet_get_main ();
1575 u32 sw_if_index = ~0;
1578 if (!unformat_user (main_input, unformat_line_input, line_input))
1580 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1582 if (unformat (line_input, "%U", unformat_ip4_address, &pfx.fp_addr.ip4))
1584 pfx.fp_proto = FIB_PROTOCOL_IP4;
1587 else if (unformat (line_input, "%U",
1588 unformat_ip6_address, &pfx.fp_addr.ip6))
1590 pfx.fp_proto = FIB_PROTOCOL_IP6;
1593 else if (unformat (line_input, "%U",
1594 unformat_vnet_sw_interface, vnm, &sw_if_index))
1597 return (clib_error_return (0, "unknown input '%U'",
1598 format_unformat_error, line_input));
1601 if (~0 == sw_if_index)
1603 vlib_cli_output (vm, "no interface");
1604 return (clib_error_return (0, "no interface"));
1607 has_proxy = ip_container_proxy_is_set (&pfx, sw_if_index);
1608 vlib_cli_output (vm, "ip container proxy is: %s", has_proxy ? "on" : "off");
1610 unformat_free (line_input);
1615 VLIB_CLI_COMMAND (show_ip_container_command, static) = {
1616 .path = "show ip container",
1617 .function = show_ip_container_cmd_fn,
1618 .short_help = "show ip container <address> <interface>",
1624 * fd.io coding-style-patch-verification: ON
1627 * eval: (c-set-style "gnu")