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>
54 #include <vnet/ethernet/arp.h>
58 * @brief IPv4 and IPv6 adjacency and lookup table managment.
63 ip_interface_address_add_del (ip_lookup_main_t * lm,
67 u32 is_del, u32 * result_if_address_index)
69 vnet_main_t *vnm = vnet_get_main ();
70 ip_interface_address_t *a, *prev, *next;
71 uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
73 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
75 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
77 /* Verify given length. */
78 if ((a && (address_length != a->address_length)) ||
79 (address_length == 0) ||
80 (lm->is_ip6 && address_length > 128) ||
81 (!lm->is_ip6 && address_length > 32))
83 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
84 return clib_error_create
85 ("%U wrong length (expected %d) for interface %U",
86 lm->format_address_and_length, addr_fib,
87 address_length, a ? a->address_length : -1,
88 format_vnet_sw_if_index_name, vnm, sw_if_index);
95 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
96 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
97 return clib_error_create ("%U not found for interface %U",
98 lm->format_address_and_length,
99 addr_fib, address_length,
100 format_vnet_sw_interface_name, vnm, si);
103 if (a->prev_this_sw_interface != ~0)
106 pool_elt_at_index (lm->if_address_pool,
107 a->prev_this_sw_interface);
108 prev->next_this_sw_interface = a->next_this_sw_interface;
110 if (a->next_this_sw_interface != ~0)
113 pool_elt_at_index (lm->if_address_pool,
114 a->next_this_sw_interface);
115 next->prev_this_sw_interface = a->prev_this_sw_interface;
117 if (a->prev_this_sw_interface == ~0)
118 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
119 a->next_this_sw_interface;
122 if ((a->next_this_sw_interface == ~0)
123 && (a->prev_this_sw_interface == ~0))
124 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
126 mhash_unset (&lm->address_to_if_address_index, addr_fib,
128 pool_put (lm->if_address_pool, a);
130 if (result_if_address_index)
131 *result_if_address_index = ~0;
136 u32 pi; /* previous index */
138 u32 hi; /* head index */
140 pool_get (lm->if_address_pool, a);
141 clib_memset (a, ~0, sizeof (a[0]));
142 ai = a - lm->if_address_pool;
144 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
146 while (pi != (u32) ~ 0)
148 prev = pool_elt_at_index (lm->if_address_pool, pi);
149 pi = prev->next_this_sw_interface;
151 pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
153 a->address_key = mhash_set (&lm->address_to_if_address_index,
154 addr_fib, ai, /* old_value */ 0);
155 a->address_length = address_length;
156 a->sw_if_index = sw_if_index;
158 a->prev_this_sw_interface = pi;
159 a->next_this_sw_interface = ~0;
161 prev->next_this_sw_interface = ai;
163 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
164 (hi != ~0) ? hi : ai;
165 if (result_if_address_index)
166 *result_if_address_index = ai;
170 if (sw_if_index != a->sw_if_index)
172 if (result_if_address_index)
173 *result_if_address_index = ~0;
174 vnm->api_errno = VNET_API_ERROR_DUPLICATE_IF_ADDRESS;
175 return clib_error_create
176 ("Prefix %U already found on interface %U",
177 lm->format_address_and_length, addr_fib, address_length,
178 format_vnet_sw_if_index_name, vnm, a->sw_if_index);
181 if (result_if_address_index)
182 *result_if_address_index = a - lm->if_address_pool;
185 return /* no error */ 0;
188 static clib_error_t *
189 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
191 vec_validate_init_empty (ip4_main.
192 lookup_main.if_address_pool_index_by_sw_if_index,
194 vec_validate_init_empty (ip6_main.
195 lookup_main.if_address_pool_index_by_sw_if_index,
201 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
204 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
206 if (!lm->fib_result_n_bytes)
207 lm->fib_result_n_bytes = sizeof (uword);
210 mhash_init (&lm->prefix_to_if_prefix_index, sizeof (uword),
211 sizeof (ip_interface_prefix_key_t));
214 lm->format_address_and_length = format_ip6_address_and_length;
215 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
216 sizeof (ip6_address_fib_t));
220 lm->format_address_and_length = format_ip4_address_and_length;
221 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
222 sizeof (ip4_address_fib_t));
228 /* Setup all IP protocols to be punted and builtin-unknown. */
229 for (i = 0; i < 256; i++)
231 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
232 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
235 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
236 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
237 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
238 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
239 IP_BUILTIN_PROTOCOL_UDP;
240 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
242 IP_BUILTIN_PROTOCOL_ICMP;
247 format_ip_flow_hash_config (u8 * s, va_list * args)
249 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
251 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
252 foreach_flow_hash_bit;
259 format_ip_adjacency_packet_data (u8 * s, va_list * args)
261 u32 adj_index = va_arg (*args, u32);
262 u8 *packet_data = va_arg (*args, u8 *);
263 u32 n_packet_data_bytes = va_arg (*args, u32);
266 if (!adj_is_valid (adj_index))
267 return format (s, "<invalid adjacency>");
269 adj = adj_get (adj_index);
271 switch (adj->lookup_next_index)
273 case IP_LOOKUP_NEXT_REWRITE:
274 case IP_LOOKUP_NEXT_MCAST:
276 format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
287 unformat_dpo (unformat_input_t * input, va_list * args)
289 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
290 fib_protocol_t fp = va_arg (*args, int);
293 proto = fib_proto_to_dpo (fp);
295 if (unformat (input, "drop"))
296 dpo_copy (dpo, drop_dpo_get (proto));
297 else if (unformat (input, "punt"))
298 dpo_copy (dpo, punt_dpo_get (proto));
299 else if (unformat (input, "local"))
300 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
301 else if (unformat (input, "null-send-unreach"))
302 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
303 else if (unformat (input, "null-send-prohibit"))
304 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
305 else if (unformat (input, "null"))
306 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
307 else if (unformat (input, "classify"))
309 u32 classify_table_index;
311 if (!unformat (input, "%d", &classify_table_index))
313 clib_warning ("classify adj must specify table index");
317 dpo_set (dpo, DPO_CLASSIFY, proto,
318 classify_dpo_create (proto, classify_table_index));
326 const ip46_address_t zero_addr = {
331 static clib_error_t *
332 vnet_ip_route_cmd (vlib_main_t * vm,
333 unformat_input_t * main_input, vlib_cli_command_t * cmd)
335 unformat_input_t _line_input, *line_input = &_line_input;
336 u32 table_id, is_del, fib_index, payload_proto;
337 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
338 fib_route_path_t *rpaths = NULL, rpath;
339 fib_prefix_t *prefixs = NULL, pfx;
340 clib_error_t *error = NULL;
347 clib_memset (&pfx, 0, sizeof (pfx));
349 /* Get a line of input. */
350 if (!unformat_user (main_input, unformat_line_input, line_input))
353 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
355 clib_memset (&rpath, 0, sizeof (rpath));
357 if (unformat (line_input, "table %d", &table_id))
359 else if (unformat (line_input, "count %f", &count))
362 else if (unformat (line_input, "%U/%d",
363 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
365 payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP4;
366 vec_add1 (prefixs, pfx);
368 else if (unformat (line_input, "%U/%d",
369 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
371 payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP6;
372 vec_add1 (prefixs, pfx);
374 else if (unformat (line_input, "via %U",
375 unformat_fib_route_path, &rpath, &payload_proto))
377 vec_add1 (rpaths, rpath);
379 else if (vec_len (prefixs) > 0 &&
380 unformat (line_input, "via %U",
381 unformat_dpo, &dpo, prefixs[0].fp_proto))
383 vec_add1 (dpos, dpo);
385 else if (unformat (line_input, "del"))
387 else if (unformat (line_input, "add"))
391 error = unformat_parse_error (line_input);
396 if (vec_len (prefixs) == 0)
399 clib_error_return (0, "expected ip4/ip6 destination address/length.");
403 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
405 error = clib_error_return (0, "expected paths.");
412 * if no table_id is passed we will manipulate the default
418 fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
422 error = clib_error_return (0, "Nonexistent table id %d", table_id);
427 for (i = 0; i < vec_len (prefixs); i++)
429 if (is_del && 0 == vec_len (rpaths))
431 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
433 else if (!is_del && 1 == vec_len (dpos))
435 fib_table_entry_special_dpo_add (fib_index,
438 FIB_ENTRY_FLAG_EXCLUSIVE,
440 dpo_reset (&dpos[0]);
442 else if (vec_len (dpos) > 0)
445 clib_error_return (0,
446 "Load-balancing over multiple special adjacencies is unsupported");
449 else if (0 < vec_len (rpaths))
452 ip46_address_t dst = prefixs[i].fp_addr;
455 t[0] = vlib_time_now (vm);
456 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
459 for (k = 0; k < n; k++)
461 fib_prefix_t rpfx = {
462 .fp_len = prefixs[i].fp_len,
463 .fp_proto = prefixs[i].fp_proto,
468 fib_table_entry_path_remove2 (fib_index,
469 &rpfx, FIB_SOURCE_CLI, rpaths);
471 fib_table_entry_path_add2 (fib_index,
474 FIB_ENTRY_FLAG_NONE, rpaths);
476 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
479 clib_host_to_net_u32 (incr +
480 clib_net_to_host_u32 (dst.
485 int bucket = (incr < 64 ? 0 : 1);
486 dst.ip6.as_u64[bucket] =
487 clib_host_to_net_u64 (incr +
488 clib_net_to_host_u64 (dst.ip6.as_u64
493 t[1] = vlib_time_now (vm);
495 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
499 error = clib_error_return (0, "Don't understand what you want...");
508 unformat_free (line_input);
513 vnet_ip_table_cmd (vlib_main_t * vm,
514 unformat_input_t * main_input,
515 vlib_cli_command_t * cmd, fib_protocol_t fproto)
517 unformat_input_t _line_input, *line_input = &_line_input;
518 clib_error_t *error = NULL;
519 u32 table_id, is_add;
525 /* Get a line of input. */
526 if (!unformat_user (main_input, unformat_line_input, line_input))
529 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
531 if (unformat (line_input, "%d", &table_id))
533 else if (unformat (line_input, "del"))
535 else if (unformat (line_input, "add"))
537 else if (unformat (line_input, "name %s", &name))
541 error = unformat_parse_error (line_input);
548 error = clib_error_return (0, "No table id");
551 else if (0 == table_id)
553 error = clib_error_return (0, "Can't change the default table");
560 ip_table_create (fproto, table_id, 0, name);
564 ip_table_delete (fproto, table_id, 0);
569 unformat_free (line_input);
574 vnet_ip4_table_cmd (vlib_main_t * vm,
575 unformat_input_t * main_input, vlib_cli_command_t * cmd)
577 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
581 vnet_ip6_table_cmd (vlib_main_t * vm,
582 unformat_input_t * main_input, vlib_cli_command_t * cmd)
584 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
588 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
590 .short_help = "Internet protocol (IP) commands",
595 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
597 .short_help = "Internet protocol version 6 (IPv6) commands",
602 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
604 .short_help = "Internet protocol (IP) show commands",
609 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
611 .short_help = "Internet protocol version 6 (IPv6) show commands",
616 * This command is used to add or delete IPv4 or IPv6 routes. All
617 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
618 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
619 * can be IPv4 or IPv6, but all must be of the same form in a single
620 * command. To display the current set of routes, use the commands
621 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
624 * Example of how to add a straight forward static route:
625 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
626 * Example of how to delete a straight forward static route:
627 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
628 * Mainly for route add/del performance testing, one can add or delete
629 * multiple routes by adding 'count N' to the previous item:
630 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
631 * Add multiple routes for the same destination to create equal-cost multipath:
632 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
633 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
634 * For unequal-cost multipath, specify the desired weights. This
635 * combination of weights results in 3/4 of the traffic following the
636 * second path, 1/4 following the first path:
637 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
638 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
639 * To add a route to a particular FIB table (VRF), use:
640 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
643 VLIB_CLI_COMMAND (ip_route_command, static) = {
645 .short_help = "ip route [add|del] [count <n>] <dst-ip-addr>/<width> [table <table-id>] via [next-hop-address] [next-hop-interface] [next-hop-table <value>] [weight <value>] [preference <value>] [udp-encap-id <value>] [ip4-lookup-in-table <value>] [ip6-lookup-in-table <value>] [mpls-lookup-in-table <value>] [resolve-via-host] [resolve-via-connected] [rx-ip4 <interface>] [out-labels <value value value>]",
646 .function = vnet_ip_route_cmd,
652 * This command is used to add or delete IPv4 Tables. All
653 * Tables must be explicitly added before that can be used. Creating a
654 * table will add both unicast and multicast FIBs
658 VLIB_CLI_COMMAND (ip4_table_command, static) = {
660 .short_help = "ip table [add|del] <table-id>",
661 .function = vnet_ip4_table_cmd,
668 * This command is used to add or delete IPv4 Tables. All
669 * Tables must be explicitly added before that can be used. Creating a
670 * table will add both unicast and multicast FIBs
674 VLIB_CLI_COMMAND (ip6_table_command, static) = {
676 .short_help = "ip6 table [add|del] <table-id>",
677 .function = vnet_ip6_table_cmd,
681 static clib_error_t *
682 ip_table_bind_cmd (vlib_main_t * vm,
683 unformat_input_t * input,
684 vlib_cli_command_t * cmd,
685 fib_protocol_t fproto)
687 vnet_main_t *vnm = vnet_get_main ();
688 clib_error_t *error = 0;
689 u32 sw_if_index, table_id;
694 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
696 error = clib_error_return (0, "unknown interface `%U'",
697 format_unformat_error, input);
701 if (unformat (input, "%d", &table_id))
705 error = clib_error_return (0, "expected table id `%U'",
706 format_unformat_error, input);
710 rv = ip_table_bind (fproto, sw_if_index, table_id, 0);
712 if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
714 error = clib_error_return (0, "IP addresses are still present on %U",
715 format_vnet_sw_if_index_name,
719 else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
721 error = clib_error_return (0, "no such table %d", table_id);
725 error = clib_error_return (0, "unknown error");
732 static clib_error_t *
733 ip4_table_bind_cmd (vlib_main_t * vm,
734 unformat_input_t * input,
735 vlib_cli_command_t * cmd)
737 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP4));
740 static clib_error_t *
741 ip6_table_bind_cmd (vlib_main_t * vm,
742 unformat_input_t * input,
743 vlib_cli_command_t * cmd)
745 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
749 * Place the indicated interface into the supplied IPv4 FIB table (also known
750 * as a VRF). The FIB table must be created using "ip table add" already. To
751 * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
752 * FIB table will only be displayed if a route has been added to the table, or
753 * an IP Address is assigned to an interface in the table (which adds a route
756 * @note IP addresses added after setting the interface IP table are added to
757 * the indicated FIB table. If an IP address is added prior to changing the
758 * table then this is an error. The control plane must remove these addresses
759 * first and then change the table. VPP will not automatically move the
760 * addresses from the old to the new table as it does not know the validity
764 * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
765 * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
768 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
770 .path = "set interface ip table",
771 .function = ip4_table_bind_cmd,
772 .short_help = "set interface ip table <interface> <table-id>",
777 * Place the indicated interface into the supplied IPv6 FIB table (also known
778 * as a VRF). The FIB table must be created using "ip6 table add" already. To
779 * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
780 * FIB table will only be displayed if a route has been added to the table, or
781 * an IP Address is assigned to an interface in the table (which adds a route
784 * @note IP addresses added after setting the interface IP table are added to
785 * the indicated FIB table. If an IP address is added prior to changing the
786 * table then this is an error. The control plane must remove these addresses
787 * first and then change the table. VPP will not automatically move the
788 * addresses from the old to the new table as it does not know the validity
792 * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
793 * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
796 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
798 .path = "set interface ip6 table",
799 .function = ip6_table_bind_cmd,
800 .short_help = "set interface ip6 table <interface> <table-id>"
805 vnet_ip_mroute_cmd (vlib_main_t * vm,
806 unformat_input_t * main_input, vlib_cli_command_t * cmd)
808 unformat_input_t _line_input, *line_input = &_line_input;
809 fib_route_path_t rpath, *rpaths = NULL;
810 clib_error_t *error = NULL;
811 u32 table_id, is_del, payload_proto;
814 mfib_entry_flags_t eflags = 0;
815 u32 gcount, scount, ss, gg, incr;
817 u32 rpf_id = MFIB_RPF_ID_NONE;
822 clib_memset (&pfx, 0, sizeof (pfx));
823 clib_memset (&rpath, 0, sizeof (rpath));
824 rpath.frp_sw_if_index = ~0;
826 /* Get a line of input. */
827 if (!unformat_user (main_input, unformat_line_input, line_input))
830 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
832 if (unformat (line_input, "table %d", &table_id))
834 else if (unformat (line_input, "del"))
836 else if (unformat (line_input, "add"))
838 else if (unformat (line_input, "rpf-id %d", &rpf_id))
840 else if (unformat (line_input, "scount %d", &scount))
842 else if (unformat (line_input, "gcount %d", &gcount))
844 else if (unformat (line_input, "%U %U",
845 unformat_ip4_address,
846 &pfx.fp_src_addr.ip4,
847 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
849 pfx.fp_proto = FIB_PROTOCOL_IP4;
852 else if (unformat (line_input, "%U %U",
853 unformat_ip6_address,
854 &pfx.fp_src_addr.ip6,
855 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
857 pfx.fp_proto = FIB_PROTOCOL_IP6;
860 else if (unformat (line_input, "%U/%d",
861 unformat_ip4_address,
862 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
864 clib_memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
865 pfx.fp_proto = FIB_PROTOCOL_IP4;
867 else if (unformat (line_input, "%U/%d",
868 unformat_ip6_address,
869 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
871 clib_memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
872 pfx.fp_proto = FIB_PROTOCOL_IP6;
874 else if (unformat (line_input, "%U",
875 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
877 clib_memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
878 pfx.fp_proto = FIB_PROTOCOL_IP4;
881 else if (unformat (line_input, "%U",
882 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
884 clib_memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
885 pfx.fp_proto = FIB_PROTOCOL_IP6;
888 else if (unformat (line_input, "via local Forward"))
890 clib_memset (&rpath.frp_addr, 0, sizeof (rpath.frp_addr));
891 rpath.frp_sw_if_index = ~0;
892 rpath.frp_weight = 1;
893 rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
895 * set the path proto appropriately for the prefix
897 rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
898 rpath.frp_mitf_flags = MFIB_ITF_FLAG_FORWARD;
900 else if (unformat (line_input, "via %U",
901 unformat_fib_route_path, &rpath, &payload_proto))
903 vec_add1 (rpaths, rpath);
905 else if (unformat (line_input, "%U",
906 unformat_mfib_itf_flags, &rpath.frp_mitf_flags))
908 else if (unformat (line_input, "%U",
909 unformat_mfib_entry_flags, &eflags))
913 error = unformat_parse_error (line_input);
921 * if no table_id is passed we will manipulate the default
927 fib_index = mfib_table_find (pfx.fp_proto, table_id);
931 error = clib_error_return (0, "Nonexistent table id %d", table_id);
936 timet[0] = vlib_time_now (vm);
938 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
940 incr = 1 << (32 - (pfx.fp_len % 32));
944 incr = 1 << (128 - (pfx.fp_len % 128));
947 for (ss = 0; ss < scount; ss++)
949 for (gg = 0; gg < gcount; gg++)
951 if (is_del && 0 == vec_len (rpaths))
953 /* no path provided => route delete */
954 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
956 else if (eflags || (MFIB_RPF_ID_NONE != rpf_id))
958 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
964 mfib_table_entry_path_remove (fib_index,
965 &pfx, MFIB_SOURCE_CLI, rpaths);
967 mfib_table_entry_path_update (fib_index,
968 &pfx, MFIB_SOURCE_CLI, rpaths);
971 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
973 pfx.fp_grp_addr.ip4.as_u32 =
974 clib_host_to_net_u32 (incr +
975 clib_net_to_host_u32 (pfx.
981 int bucket = (incr < 64 ? 0 : 1);
982 pfx.fp_grp_addr.ip6.as_u64[bucket] =
983 clib_host_to_net_u64 (incr +
984 clib_net_to_host_u64 (pfx.
985 fp_grp_addr.ip6.as_u64
990 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
992 pfx.fp_src_addr.ip4.as_u32 =
993 clib_host_to_net_u32 (1 +
994 clib_net_to_host_u32 (pfx.fp_src_addr.
999 pfx.fp_src_addr.ip6.as_u64[1] =
1000 clib_host_to_net_u64 (1 +
1001 clib_net_to_host_u64 (pfx.fp_src_addr.
1006 timet[1] = vlib_time_now (vm);
1008 if (scount > 1 || gcount > 1)
1009 vlib_cli_output (vm, "%.6e routes/sec",
1010 (scount * gcount) / (timet[1] - timet[0]));
1014 unformat_free (line_input);
1020 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
1021 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
1022 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
1023 * can be IPv4 or IPv6, but all must be of the same form in a single
1024 * command. To display the current set of routes, use the commands
1025 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
1026 * The full set of support flags for interfaces and route is shown via;
1027 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
1030 * Example of how to add a forwarding interface to a route (and create the
1031 * route if it does not exist)
1032 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1033 * Example of how to add an accepting interface to a route (and create the
1034 * route if it does not exist)
1035 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1036 * Example of changing the route's flags to send signals via the API
1037 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1041 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1043 .path = "ip mroute",
1044 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [rpf-id <ID>] [via <next-hop-ip-addr> [<interface>],",
1045 .function = vnet_ip_mroute_cmd,
1051 * The next two routines address a longstanding script hemorrhoid.
1052 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1053 * or dependent route-adds will simply fail.
1055 static clib_error_t *
1056 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1059 vnet_main_t *vnm = vnet_get_main ();
1064 uword *event_data = 0;
1066 ASSERT (vlib_in_process_context (vm));
1068 if (retry_count > 0)
1069 vnet_register_ip6_neighbor_resolution_event
1070 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1071 1 /* event */ , 0 /* data */ );
1073 for (i = 0; i < retry_count; i++)
1075 /* The interface may be down, etc. */
1076 e = ip6_probe_neighbor (vm, a, sw_if_index, 0);
1081 vlib_process_wait_for_event_or_clock (vm, 1.0);
1082 event_type = vlib_process_get_events (vm, &event_data);
1085 case 1: /* resolved... */
1086 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1090 case ~0: /* timeout */
1094 clib_warning ("unknown event_type %d", event_type);
1096 vec_reset_length (event_data);
1102 return clib_error_return (0, "Resolution failed for %U",
1103 format_ip6_address, a);
1107 static clib_error_t *
1108 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1111 vnet_main_t *vnm = vnet_get_main ();
1116 uword *event_data = 0;
1118 ASSERT (vlib_in_process_context (vm));
1120 if (retry_count > 0)
1121 vnet_register_ip4_arp_resolution_event
1122 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1123 1 /* event */ , 0 /* data */ );
1125 for (i = 0; i < retry_count; i++)
1127 /* The interface may be down, etc. */
1128 e = ip4_probe_neighbor (vm, a, sw_if_index, 0);
1133 vlib_process_wait_for_event_or_clock (vm, 1.0);
1134 event_type = vlib_process_get_events (vm, &event_data);
1137 case 1: /* resolved... */
1138 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1142 case ~0: /* timeout */
1146 clib_warning ("unknown event_type %d", event_type);
1148 vec_reset_length (event_data);
1153 vec_reset_length (event_data);
1156 return clib_error_return (0, "Resolution failed for %U",
1157 format_ip4_address, a);
1161 static clib_error_t *
1162 probe_neighbor_address (vlib_main_t * vm,
1163 unformat_input_t * input, vlib_cli_command_t * cmd)
1165 vnet_main_t *vnm = vnet_get_main ();
1166 unformat_input_t _line_input, *line_input = &_line_input;
1169 clib_error_t *error = 0;
1170 u32 sw_if_index = ~0;
1171 int retry_count = 3;
1173 int address_set = 0;
1175 /* Get a line of input. */
1176 if (!unformat_user (input, unformat_line_input, line_input))
1179 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1181 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1184 else if (unformat (line_input, "retry %d", &retry_count))
1187 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1189 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1196 error = clib_error_return (0, "unknown input '%U'",
1197 format_unformat_error, line_input);
1202 if (sw_if_index == ~0)
1204 error = clib_error_return (0, "Interface required, not set.");
1207 if (address_set == 0)
1209 error = clib_error_return (0, "ip address required, not set.");
1212 if (address_set > 1)
1214 error = clib_error_return (0, "Multiple ip addresses not supported.");
1219 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1221 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1224 unformat_free (line_input);
1230 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1231 * attempts IPv6 neighbor discovery depending on the supplied IP address
1234 * @note This command will not immediately affect the indicated FIB; it
1235 * is not suitable for use in establishing a FIB entry prior to adding
1236 * recursive FIB entries. As in: don't use it in a script to probe a
1237 * gateway prior to adding a default route. It won't work. Instead,
1238 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1239 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1242 * Example of probe for an IPv4 address:
1243 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1246 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1247 .path = "ip probe-neighbor",
1248 .function = probe_neighbor_address,
1249 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1255 vnet_ip_container_proxy_add_del (vnet_ip_container_proxy_args_t * args)
1259 if (!vnet_sw_interface_is_api_valid (vnet_get_main (), args->sw_if_index))
1260 return clib_error_return_code (0, VNET_API_ERROR_INVALID_INTERFACE, 0,
1261 "invalid sw_if_index");
1263 fib_index = fib_table_get_table_id_for_sw_if_index (args->prefix.fp_proto,
1267 dpo_id_t proxy_dpo = DPO_INVALID;
1268 l3_proxy_dpo_add_or_lock (fib_proto_to_dpo (args->prefix.fp_proto),
1269 args->sw_if_index, &proxy_dpo);
1270 fib_table_entry_special_dpo_add (fib_index,
1273 FIB_ENTRY_FLAG_EXCLUSIVE, &proxy_dpo);
1274 dpo_reset (&proxy_dpo);
1278 fib_table_entry_special_remove (fib_index, &args->prefix,
1285 ip_container_proxy_is_set (fib_prefix_t * pfx, u32 sw_if_index)
1288 fib_node_index_t fei;
1289 const dpo_id_t *dpo;
1290 l3_proxy_dpo_t *l3p;
1291 load_balance_t *lb0;
1293 fib_index = fib_table_get_table_id_for_sw_if_index (pfx->fp_proto,
1295 if (fib_index == ~0)
1298 fei = fib_table_lookup_exact_match (fib_index, pfx);
1299 if (fei == FIB_NODE_INDEX_INVALID)
1302 dpo = fib_entry_contribute_ip_forwarding (fei);
1303 lb0 = load_balance_get (dpo->dpoi_index);
1304 dpo = load_balance_get_bucket_i (lb0, 0);
1305 if (dpo->dpoi_type != DPO_L3_PROXY)
1308 l3p = l3_proxy_dpo_get (dpo->dpoi_index);
1309 return (l3p->l3p_sw_if_index == sw_if_index);
1312 typedef struct ip_container_proxy_walk_ctx_t_
1314 ip_container_proxy_cb_t cb;
1316 } ip_container_proxy_walk_ctx_t;
1318 static fib_table_walk_rc_t
1319 ip_container_proxy_fib_table_walk (fib_node_index_t fei, void *arg)
1321 ip_container_proxy_walk_ctx_t *ctx = arg;
1322 const fib_prefix_t *pfx;
1323 const dpo_id_t *dpo;
1325 l3_proxy_dpo_t *l3p;
1327 pfx = fib_entry_get_prefix (fei);
1328 if (fib_entry_is_sourced (fei, FIB_SOURCE_PROXY))
1330 dpo = fib_entry_contribute_ip_forwarding (fei);
1331 lb = load_balance_get (dpo->dpoi_index);
1332 dpo = load_balance_get_bucket_i (lb, 0);
1333 l3p = l3_proxy_dpo_get (dpo->dpoi_index);
1334 ctx->cb (pfx, l3p->l3p_sw_if_index, ctx->ctx);
1337 return FIB_TABLE_WALK_CONTINUE;
1341 ip_container_proxy_walk (ip_container_proxy_cb_t cb, void *ctx)
1343 fib_table_t *fib_table;
1344 ip_container_proxy_walk_ctx_t wctx = {
1350 pool_foreach (fib_table, ip4_main.fibs,
1352 fib_table_walk(fib_table->ft_index,
1354 ip_container_proxy_fib_table_walk,
1357 pool_foreach (fib_table, ip6_main.fibs,
1359 fib_table_walk(fib_table->ft_index,
1361 ip_container_proxy_fib_table_walk,
1368 ip_container_cmd (vlib_main_t * vm,
1369 unformat_input_t * main_input, vlib_cli_command_t * cmd)
1371 unformat_input_t _line_input, *line_input = &_line_input;
1373 u32 is_del, addr_set = 0;
1377 vnm = vnet_get_main ();
1380 clib_memset (&pfx, 0, sizeof (pfx));
1382 /* Get a line of input. */
1383 if (!unformat_user (main_input, unformat_line_input, line_input))
1386 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1388 if (unformat (line_input, "%U", unformat_ip4_address, &pfx.fp_addr.ip4))
1390 pfx.fp_proto = FIB_PROTOCOL_IP4;
1394 else if (unformat (line_input, "%U",
1395 unformat_ip6_address, &pfx.fp_addr.ip6))
1397 pfx.fp_proto = FIB_PROTOCOL_IP6;
1401 else if (unformat (line_input, "%U",
1402 unformat_vnet_sw_interface, vnm, &sw_if_index))
1404 else if (unformat (line_input, "del"))
1408 unformat_free (line_input);
1409 return (clib_error_return (0, "unknown input '%U'",
1410 format_unformat_error, line_input));
1414 if (~0 == sw_if_index || !addr_set)
1416 unformat_free (line_input);
1417 vlib_cli_output (vm, "interface and address must be set");
1421 vnet_ip_container_proxy_args_t args = {
1423 .sw_if_index = sw_if_index,
1426 vnet_ip_container_proxy_add_del (&args);
1427 unformat_free (line_input);
1432 VLIB_CLI_COMMAND (ip_container_command_node, static) = {
1433 .path = "ip container",
1434 .function = ip_container_cmd,
1435 .short_help = "ip container <address> <interface>",
1441 show_ip_container_cmd_fn (vlib_main_t * vm, unformat_input_t * main_input,
1442 vlib_cli_command_t * cmd)
1444 unformat_input_t _line_input, *line_input = &_line_input;
1445 vnet_main_t *vnm = vnet_get_main ();
1447 u32 sw_if_index = ~0;
1450 if (!unformat_user (main_input, unformat_line_input, line_input))
1452 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1454 if (unformat (line_input, "%U", unformat_ip4_address, &pfx.fp_addr.ip4))
1456 pfx.fp_proto = FIB_PROTOCOL_IP4;
1459 else if (unformat (line_input, "%U",
1460 unformat_ip6_address, &pfx.fp_addr.ip6))
1462 pfx.fp_proto = FIB_PROTOCOL_IP6;
1465 else if (unformat (line_input, "%U",
1466 unformat_vnet_sw_interface, vnm, &sw_if_index))
1470 unformat_free (line_input);
1471 return (clib_error_return (0, "unknown input '%U'",
1472 format_unformat_error, line_input));
1476 if (~0 == sw_if_index)
1478 unformat_free (line_input);
1479 vlib_cli_output (vm, "no interface");
1480 return (clib_error_return (0, "no interface"));
1483 has_proxy = ip_container_proxy_is_set (&pfx, sw_if_index);
1484 vlib_cli_output (vm, "ip container proxy is: %s", has_proxy ? "on" : "off");
1486 unformat_free (line_input);
1491 VLIB_CLI_COMMAND (show_ip_container_command, static) = {
1492 .path = "show ip container",
1493 .function = show_ip_container_cmd_fn,
1494 .short_help = "show ip container <address> <interface>",
1500 * fd.io coding-style-patch-verification: ON
1503 * eval: (c-set-style "gnu")