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);
212 lm->format_address_and_length = format_ip6_address_and_length;
213 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
214 sizeof (ip6_address_fib_t));
218 lm->format_address_and_length = format_ip4_address_and_length;
219 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
220 sizeof (ip4_address_fib_t));
226 /* Setup all IP protocols to be punted and builtin-unknown. */
227 for (i = 0; i < 256; i++)
229 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
230 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
233 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
234 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
235 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
236 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
237 IP_BUILTIN_PROTOCOL_UDP;
238 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
240 IP_BUILTIN_PROTOCOL_ICMP;
245 format_ip_flow_hash_config (u8 * s, va_list * args)
247 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
249 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
250 foreach_flow_hash_bit;
257 format_ip_adjacency_packet_data (u8 * s, va_list * args)
259 u32 adj_index = va_arg (*args, u32);
260 u8 *packet_data = va_arg (*args, u8 *);
261 u32 n_packet_data_bytes = va_arg (*args, u32);
262 ip_adjacency_t *adj = adj_get (adj_index);
264 switch (adj->lookup_next_index)
266 case IP_LOOKUP_NEXT_REWRITE:
267 case IP_LOOKUP_NEXT_MCAST:
269 format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
280 unformat_dpo (unformat_input_t * input, va_list * args)
282 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
283 fib_protocol_t fp = va_arg (*args, int);
286 proto = fib_proto_to_dpo (fp);
288 if (unformat (input, "drop"))
289 dpo_copy (dpo, drop_dpo_get (proto));
290 else if (unformat (input, "punt"))
291 dpo_copy (dpo, punt_dpo_get (proto));
292 else if (unformat (input, "local"))
293 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
294 else if (unformat (input, "null-send-unreach"))
295 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
296 else if (unformat (input, "null-send-prohibit"))
297 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
298 else if (unformat (input, "null"))
299 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
300 else if (unformat (input, "classify"))
302 u32 classify_table_index;
304 if (!unformat (input, "%d", &classify_table_index))
306 clib_warning ("classify adj must specify table index");
310 dpo_set (dpo, DPO_CLASSIFY, proto,
311 classify_dpo_create (proto, classify_table_index));
319 const ip46_address_t zero_addr = {
324 static clib_error_t *
325 vnet_ip_route_cmd (vlib_main_t * vm,
326 unformat_input_t * main_input, vlib_cli_command_t * cmd)
328 unformat_input_t _line_input, *line_input = &_line_input;
329 u32 table_id, is_del, fib_index, payload_proto;
330 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
331 fib_route_path_t *rpaths = NULL, rpath;
332 fib_prefix_t *prefixs = NULL, pfx;
333 clib_error_t *error = NULL;
340 clib_memset (&pfx, 0, sizeof (pfx));
342 /* Get a line of input. */
343 if (!unformat_user (main_input, unformat_line_input, line_input))
346 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
348 clib_memset (&rpath, 0, sizeof (rpath));
350 if (unformat (line_input, "table %d", &table_id))
352 else if (unformat (line_input, "count %f", &count))
355 else if (unformat (line_input, "%U/%d",
356 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
358 payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP4;
359 vec_add1 (prefixs, pfx);
361 else if (unformat (line_input, "%U/%d",
362 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
364 payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP6;
365 vec_add1 (prefixs, pfx);
367 else if (unformat (line_input, "via %U",
368 unformat_fib_route_path, &rpath, &payload_proto))
370 vec_add1 (rpaths, rpath);
372 else if (vec_len (prefixs) > 0 &&
373 unformat (line_input, "via %U",
374 unformat_dpo, &dpo, prefixs[0].fp_proto))
376 vec_add1 (dpos, dpo);
378 else if (unformat (line_input, "del"))
380 else if (unformat (line_input, "add"))
384 error = unformat_parse_error (line_input);
389 if (vec_len (prefixs) == 0)
392 clib_error_return (0, "expected ip4/ip6 destination address/length.");
396 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
398 error = clib_error_return (0, "expected paths.");
405 * if no table_id is passed we will manipulate the default
411 fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
415 error = clib_error_return (0, "Nonexistent table id %d", table_id);
420 for (i = 0; i < vec_len (prefixs); i++)
422 if (is_del && 0 == vec_len (rpaths))
424 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
426 else if (!is_del && 1 == vec_len (dpos))
428 fib_table_entry_special_dpo_add (fib_index,
431 FIB_ENTRY_FLAG_EXCLUSIVE,
433 dpo_reset (&dpos[0]);
435 else if (vec_len (dpos) > 0)
438 clib_error_return (0,
439 "Load-balancing over multiple special adjacencies is unsupported");
442 else if (0 < vec_len (rpaths))
445 ip46_address_t dst = prefixs[i].fp_addr;
448 t[0] = vlib_time_now (vm);
449 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
452 for (k = 0; k < n; k++)
454 for (j = 0; j < vec_len (rpaths); j++)
456 fib_prefix_t rpfx = {
457 .fp_len = prefixs[i].fp_len,
458 .fp_proto = prefixs[i].fp_proto,
463 fib_table_entry_path_remove2 (fib_index,
465 FIB_SOURCE_CLI, &rpaths[j]);
467 fib_table_entry_path_add2 (fib_index,
474 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
477 clib_host_to_net_u32 (incr +
478 clib_net_to_host_u32 (dst.
483 int bucket = (incr < 64 ? 0 : 1);
484 dst.ip6.as_u64[bucket] =
485 clib_host_to_net_u64 (incr +
486 clib_net_to_host_u64 (dst.ip6.as_u64
491 t[1] = vlib_time_now (vm);
493 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
497 error = clib_error_return (0, "Don't understand what you want...");
507 unformat_free (line_input);
512 vnet_ip_table_cmd (vlib_main_t * vm,
513 unformat_input_t * main_input,
514 vlib_cli_command_t * cmd, fib_protocol_t fproto)
516 unformat_input_t _line_input, *line_input = &_line_input;
517 clib_error_t *error = NULL;
518 u32 table_id, is_add;
524 /* Get a line of input. */
525 if (!unformat_user (main_input, unformat_line_input, line_input))
528 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
530 if (unformat (line_input, "%d", &table_id))
532 else if (unformat (line_input, "del"))
534 else if (unformat (line_input, "add"))
536 else if (unformat (line_input, "name %s", &name))
540 error = unformat_parse_error (line_input);
547 error = clib_error_return (0, "No table id");
550 else if (0 == table_id)
552 error = clib_error_return (0, "Can't change the default table");
559 ip_table_create (fproto, table_id, 0, name);
563 ip_table_delete (fproto, table_id, 0);
568 unformat_free (line_input);
573 vnet_ip4_table_cmd (vlib_main_t * vm,
574 unformat_input_t * main_input, vlib_cli_command_t * cmd)
576 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
580 vnet_ip6_table_cmd (vlib_main_t * vm,
581 unformat_input_t * main_input, vlib_cli_command_t * cmd)
583 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
587 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
589 .short_help = "Internet protocol (IP) commands",
594 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
596 .short_help = "Internet protocol version 6 (IPv6) commands",
601 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
603 .short_help = "Internet protocol (IP) show commands",
608 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
610 .short_help = "Internet protocol version 6 (IPv6) show commands",
615 * This command is used to add or delete IPv4 or IPv6 routes. All
616 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
617 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
618 * can be IPv4 or IPv6, but all must be of the same form in a single
619 * command. To display the current set of routes, use the commands
620 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
623 * Example of how to add a straight forward static route:
624 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
625 * Example of how to delete a straight forward static route:
626 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
627 * Mainly for route add/del performance testing, one can add or delete
628 * multiple routes by adding 'count N' to the previous item:
629 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
630 * Add multiple routes for the same destination to create equal-cost multipath:
631 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
632 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
633 * For unequal-cost multipath, specify the desired weights. This
634 * combination of weights results in 3/4 of the traffic following the
635 * second path, 1/4 following the first path:
636 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
637 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
638 * To add a route to a particular FIB table (VRF), use:
639 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
642 VLIB_CLI_COMMAND (ip_route_command, static) = {
644 .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>]",
645 .function = vnet_ip_route_cmd,
651 * This command is used to add or delete IPv4 Tables. All
652 * Tables must be explicitly added before that can be used. Creating a
653 * table will add both unicast and multicast FIBs
657 VLIB_CLI_COMMAND (ip4_table_command, static) = {
659 .short_help = "ip table [add|del] <table-id>",
660 .function = vnet_ip4_table_cmd,
667 * This command is used to add or delete IPv4 Tables. All
668 * Tables must be explicitly added before that can be used. Creating a
669 * table will add both unicast and multicast FIBs
673 VLIB_CLI_COMMAND (ip6_table_command, static) = {
675 .short_help = "ip6 table [add|del] <table-id>",
676 .function = vnet_ip6_table_cmd,
680 static clib_error_t *
681 ip_table_bind_cmd (vlib_main_t * vm,
682 unformat_input_t * input,
683 vlib_cli_command_t * cmd,
684 fib_protocol_t fproto)
686 vnet_main_t *vnm = vnet_get_main ();
687 clib_error_t *error = 0;
688 u32 sw_if_index, table_id;
693 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
695 error = clib_error_return (0, "unknown interface `%U'",
696 format_unformat_error, input);
700 if (unformat (input, "%d", &table_id))
704 error = clib_error_return (0, "expected table id `%U'",
705 format_unformat_error, input);
709 rv = ip_table_bind (fproto, sw_if_index, table_id, 0);
711 if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
713 error = clib_error_return (0, "IP addresses are still present on %U",
714 format_vnet_sw_if_index_name,
718 else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
720 error = clib_error_return (0, "no such table %d", table_id);
724 error = clib_error_return (0, "unknown error");
731 static clib_error_t *
732 ip4_table_bind_cmd (vlib_main_t * vm,
733 unformat_input_t * input,
734 vlib_cli_command_t * cmd)
736 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP4));
739 static clib_error_t *
740 ip6_table_bind_cmd (vlib_main_t * vm,
741 unformat_input_t * input,
742 vlib_cli_command_t * cmd)
744 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
748 * Place the indicated interface into the supplied IPv4 FIB table (also known
749 * as a VRF). The FIB table must be created using "ip table add" already. To
750 * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
751 * FIB table will only be displayed if a route has been added to the table, or
752 * an IP Address is assigned to an interface in the table (which adds a route
755 * @note IP addresses added after setting the interface IP table are added to
756 * the indicated FIB table. If an IP address is added prior to changing the
757 * table then this is an error. The control plane must remove these addresses
758 * first and then change the table. VPP will not automatically move the
759 * addresses from the old to the new table as it does not know the validity
763 * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
764 * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
767 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
769 .path = "set interface ip table",
770 .function = ip4_table_bind_cmd,
771 .short_help = "set interface ip table <interface> <table-id>",
776 * Place the indicated interface into the supplied IPv6 FIB table (also known
777 * as a VRF). The FIB table must be created using "ip6 table add" already. To
778 * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
779 * FIB table will only be displayed if a route has been added to the table, or
780 * an IP Address is assigned to an interface in the table (which adds a route
783 * @note IP addresses added after setting the interface IP table are added to
784 * the indicated FIB table. If an IP address is added prior to changing the
785 * table then this is an error. The control plane must remove these addresses
786 * first and then change the table. VPP will not automatically move the
787 * addresses from the old to the new table as it does not know the validity
791 * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
792 * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
795 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
797 .path = "set interface ip6 table",
798 .function = ip6_table_bind_cmd,
799 .short_help = "set interface ip6 table <interface> <table-id>"
804 vnet_ip_mroute_cmd (vlib_main_t * vm,
805 unformat_input_t * main_input, vlib_cli_command_t * cmd)
807 unformat_input_t _line_input, *line_input = &_line_input;
808 clib_error_t *error = NULL;
809 fib_route_path_t rpath;
810 u32 table_id, is_del;
814 mfib_itf_flags_t iflags = 0;
815 mfib_entry_flags_t eflags = 0;
816 u32 gcount, scount, ss, gg, incr;
818 u32 rpf_id = MFIB_RPF_ID_NONE;
821 vnm = vnet_get_main ();
824 clib_memset (&pfx, 0, sizeof (pfx));
825 clib_memset (&rpath, 0, sizeof (rpath));
826 rpath.frp_sw_if_index = ~0;
828 /* Get a line of input. */
829 if (!unformat_user (main_input, unformat_line_input, line_input))
832 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
834 if (unformat (line_input, "table %d", &table_id))
836 else if (unformat (line_input, "del"))
838 else if (unformat (line_input, "add"))
840 else if (unformat (line_input, "rpf-id %d", &rpf_id))
842 else if (unformat (line_input, "scount %d", &scount))
844 else if (unformat (line_input, "gcount %d", &gcount))
846 else if (unformat (line_input, "%U %U",
847 unformat_ip4_address,
848 &pfx.fp_src_addr.ip4,
849 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
851 pfx.fp_proto = FIB_PROTOCOL_IP4;
854 else if (unformat (line_input, "%U %U",
855 unformat_ip6_address,
856 &pfx.fp_src_addr.ip6,
857 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
859 pfx.fp_proto = FIB_PROTOCOL_IP6;
862 else if (unformat (line_input, "%U/%d",
863 unformat_ip4_address,
864 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
866 clib_memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
867 pfx.fp_proto = FIB_PROTOCOL_IP4;
869 else if (unformat (line_input, "%U/%d",
870 unformat_ip6_address,
871 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
873 clib_memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
874 pfx.fp_proto = FIB_PROTOCOL_IP6;
876 else if (unformat (line_input, "%U",
877 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
879 clib_memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
880 pfx.fp_proto = FIB_PROTOCOL_IP4;
883 else if (unformat (line_input, "%U",
884 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
886 clib_memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
887 pfx.fp_proto = FIB_PROTOCOL_IP6;
890 else if (unformat (line_input, "via %U %U %U",
891 unformat_ip4_address, &rpath.frp_addr.ip4,
892 unformat_vnet_sw_interface, vnm,
893 &rpath.frp_sw_if_index,
894 unformat_mfib_itf_flags, &iflags))
896 rpath.frp_weight = 1;
898 else if (unformat (line_input, "via %U %U %U",
899 unformat_ip6_address, &rpath.frp_addr.ip6,
900 unformat_vnet_sw_interface, vnm,
901 &rpath.frp_sw_if_index,
902 unformat_mfib_itf_flags, &iflags))
904 rpath.frp_weight = 1;
906 else if (unformat (line_input, "via %U %U",
907 unformat_vnet_sw_interface, vnm,
908 &rpath.frp_sw_if_index,
909 unformat_mfib_itf_flags, &iflags))
911 clib_memset (&rpath.frp_addr, 0, sizeof (rpath.frp_addr));
912 rpath.frp_weight = 1;
914 else if (unformat (line_input, "via %U %U",
915 unformat_ip4_address, &rpath.frp_addr.ip4,
916 unformat_vnet_sw_interface, vnm,
917 &rpath.frp_sw_if_index))
919 rpath.frp_weight = 1;
921 else if (unformat (line_input, "via %U %U",
922 unformat_ip6_address, &rpath.frp_addr.ip6,
923 unformat_vnet_sw_interface, vnm,
924 &rpath.frp_sw_if_index))
926 rpath.frp_weight = 1;
928 else if (unformat (line_input, "via %U",
929 unformat_vnet_sw_interface, vnm,
930 &rpath.frp_sw_if_index))
932 clib_memset (&rpath.frp_addr, 0, sizeof (rpath.frp_addr));
933 rpath.frp_weight = 1;
935 else if (unformat (line_input, "via local Forward"))
937 clib_memset (&rpath.frp_addr, 0, sizeof (rpath.frp_addr));
938 rpath.frp_sw_if_index = ~0;
939 rpath.frp_weight = 1;
940 rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
942 * set the path proto appropriately for the prefix
944 rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
945 iflags = MFIB_ITF_FLAG_FORWARD;
947 else if (unformat (line_input, "%U",
948 unformat_mfib_entry_flags, &eflags))
952 error = unformat_parse_error (line_input);
960 * if no table_id is passed we will manipulate the default
966 fib_index = mfib_table_find (pfx.fp_proto, table_id);
970 error = clib_error_return (0, "Nonexistent table id %d", table_id);
975 timet[0] = vlib_time_now (vm);
977 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
979 incr = 1 << (32 - (pfx.fp_len % 32));
983 incr = 1 << (128 - (pfx.fp_len % 128));
986 for (ss = 0; ss < scount; ss++)
988 for (gg = 0; gg < gcount; gg++)
990 if (is_del && 0 == rpath.frp_weight)
992 /* no path provided => route delete */
993 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
995 else if (eflags || (MFIB_RPF_ID_NONE != rpf_id))
997 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
1003 mfib_table_entry_path_remove (fib_index,
1004 &pfx, MFIB_SOURCE_CLI, &rpath);
1006 mfib_table_entry_path_update (fib_index,
1007 &pfx, MFIB_SOURCE_CLI, &rpath,
1011 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1013 pfx.fp_grp_addr.ip4.as_u32 =
1014 clib_host_to_net_u32 (incr +
1015 clib_net_to_host_u32 (pfx.
1021 int bucket = (incr < 64 ? 0 : 1);
1022 pfx.fp_grp_addr.ip6.as_u64[bucket] =
1023 clib_host_to_net_u64 (incr +
1024 clib_net_to_host_u64 (pfx.
1025 fp_grp_addr.ip6.as_u64
1030 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1032 pfx.fp_src_addr.ip4.as_u32 =
1033 clib_host_to_net_u32 (1 +
1034 clib_net_to_host_u32 (pfx.fp_src_addr.
1039 pfx.fp_src_addr.ip6.as_u64[1] =
1040 clib_host_to_net_u64 (1 +
1041 clib_net_to_host_u64 (pfx.fp_src_addr.
1046 timet[1] = vlib_time_now (vm);
1048 if (scount > 1 || gcount > 1)
1049 vlib_cli_output (vm, "%.6e routes/sec",
1050 (scount * gcount) / (timet[1] - timet[0]));
1053 unformat_free (line_input);
1059 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
1060 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
1061 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
1062 * can be IPv4 or IPv6, but all must be of the same form in a single
1063 * command. To display the current set of routes, use the commands
1064 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
1065 * The full set of support flags for interfaces and route is shown via;
1066 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
1069 * Example of how to add a forwarding interface to a route (and create the
1070 * route if it does not exist)
1071 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1072 * Example of how to add an accepting interface to a route (and create the
1073 * route if it does not exist)
1074 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1075 * Example of changing the route's flags to send signals via the API
1076 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1080 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1082 .path = "ip mroute",
1083 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [rpf-id <ID>] [via <next-hop-ip-addr> [<interface>],",
1084 .function = vnet_ip_mroute_cmd,
1090 * The next two routines address a longstanding script hemorrhoid.
1091 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1092 * or dependent route-adds will simply fail.
1094 static clib_error_t *
1095 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1098 vnet_main_t *vnm = vnet_get_main ();
1103 uword *event_data = 0;
1105 ASSERT (vlib_in_process_context (vm));
1107 if (retry_count > 0)
1108 vnet_register_ip6_neighbor_resolution_event
1109 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1110 1 /* event */ , 0 /* data */ );
1112 for (i = 0; i < retry_count; i++)
1114 /* The interface may be down, etc. */
1115 e = ip6_probe_neighbor (vm, a, sw_if_index, 0);
1120 vlib_process_wait_for_event_or_clock (vm, 1.0);
1121 event_type = vlib_process_get_events (vm, &event_data);
1124 case 1: /* resolved... */
1125 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1129 case ~0: /* timeout */
1133 clib_warning ("unknown event_type %d", event_type);
1135 vec_reset_length (event_data);
1141 return clib_error_return (0, "Resolution failed for %U",
1142 format_ip6_address, a);
1146 static clib_error_t *
1147 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1150 vnet_main_t *vnm = vnet_get_main ();
1155 uword *event_data = 0;
1157 ASSERT (vlib_in_process_context (vm));
1159 if (retry_count > 0)
1160 vnet_register_ip4_arp_resolution_event
1161 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1162 1 /* event */ , 0 /* data */ );
1164 for (i = 0; i < retry_count; i++)
1166 /* The interface may be down, etc. */
1167 e = ip4_probe_neighbor (vm, a, sw_if_index, 0);
1172 vlib_process_wait_for_event_or_clock (vm, 1.0);
1173 event_type = vlib_process_get_events (vm, &event_data);
1176 case 1: /* resolved... */
1177 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1181 case ~0: /* timeout */
1185 clib_warning ("unknown event_type %d", event_type);
1187 vec_reset_length (event_data);
1192 vec_reset_length (event_data);
1195 return clib_error_return (0, "Resolution failed for %U",
1196 format_ip4_address, a);
1200 static clib_error_t *
1201 probe_neighbor_address (vlib_main_t * vm,
1202 unformat_input_t * input, vlib_cli_command_t * cmd)
1204 vnet_main_t *vnm = vnet_get_main ();
1205 unformat_input_t _line_input, *line_input = &_line_input;
1208 clib_error_t *error = 0;
1209 u32 sw_if_index = ~0;
1210 int retry_count = 3;
1212 int address_set = 0;
1214 /* Get a line of input. */
1215 if (!unformat_user (input, unformat_line_input, line_input))
1218 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1220 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1223 else if (unformat (line_input, "retry %d", &retry_count))
1226 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1228 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1235 error = clib_error_return (0, "unknown input '%U'",
1236 format_unformat_error, line_input);
1241 if (sw_if_index == ~0)
1243 error = clib_error_return (0, "Interface required, not set.");
1246 if (address_set == 0)
1248 error = clib_error_return (0, "ip address required, not set.");
1251 if (address_set > 1)
1253 error = clib_error_return (0, "Multiple ip addresses not supported.");
1258 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1260 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1263 unformat_free (line_input);
1269 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1270 * attempts IPv6 neighbor discovery depending on the supplied IP address
1273 * @note This command will not immediately affect the indicated FIB; it
1274 * is not suitable for use in establishing a FIB entry prior to adding
1275 * recursive FIB entries. As in: don't use it in a script to probe a
1276 * gateway prior to adding a default route. It won't work. Instead,
1277 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1278 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1281 * Example of probe for an IPv4 address:
1282 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1285 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1286 .path = "ip probe-neighbor",
1287 .function = probe_neighbor_address,
1288 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1294 vnet_ip_container_proxy_add_del (vnet_ip_container_proxy_args_t * args)
1298 if (!vnet_sw_interface_is_api_valid (vnet_get_main (), args->sw_if_index))
1299 return clib_error_return_code (0, VNET_API_ERROR_INVALID_INTERFACE, 0,
1300 "invalid sw_if_index");
1302 fib_index = fib_table_get_table_id_for_sw_if_index (args->prefix.fp_proto,
1306 dpo_id_t proxy_dpo = DPO_INVALID;
1307 l3_proxy_dpo_add_or_lock (fib_proto_to_dpo (args->prefix.fp_proto),
1308 args->sw_if_index, &proxy_dpo);
1309 fib_table_entry_special_dpo_add (fib_index,
1312 FIB_ENTRY_FLAG_EXCLUSIVE, &proxy_dpo);
1313 dpo_reset (&proxy_dpo);
1317 fib_table_entry_special_remove (fib_index, &args->prefix,
1324 ip_container_proxy_is_set (fib_prefix_t * pfx, u32 sw_if_index)
1327 fib_node_index_t fei;
1328 const dpo_id_t *dpo;
1329 l3_proxy_dpo_t *l3p;
1330 load_balance_t *lb0;
1332 fib_index = fib_table_get_table_id_for_sw_if_index (pfx->fp_proto,
1334 if (fib_index == ~0)
1337 fei = fib_table_lookup_exact_match (fib_index, pfx);
1338 if (fei == FIB_NODE_INDEX_INVALID)
1341 dpo = fib_entry_contribute_ip_forwarding (fei);
1342 lb0 = load_balance_get (dpo->dpoi_index);
1343 dpo = load_balance_get_bucket_i (lb0, 0);
1344 if (dpo->dpoi_type != DPO_L3_PROXY)
1347 l3p = l3_proxy_dpo_get (dpo->dpoi_index);
1348 return (l3p->l3p_sw_if_index == sw_if_index);
1351 typedef struct ip_container_proxy_walk_ctx_t_
1353 ip_container_proxy_cb_t cb;
1355 } ip_container_proxy_walk_ctx_t;
1357 static fib_table_walk_rc_t
1358 ip_container_proxy_fib_table_walk (fib_node_index_t fei, void *arg)
1360 ip_container_proxy_walk_ctx_t *ctx = arg;
1361 const fib_prefix_t *pfx;
1362 const dpo_id_t *dpo;
1364 l3_proxy_dpo_t *l3p;
1366 pfx = fib_entry_get_prefix (fei);
1367 if (fib_entry_is_sourced (fei, FIB_SOURCE_PROXY))
1369 dpo = fib_entry_contribute_ip_forwarding (fei);
1370 lb = load_balance_get (dpo->dpoi_index);
1371 dpo = load_balance_get_bucket_i (lb, 0);
1372 l3p = l3_proxy_dpo_get (dpo->dpoi_index);
1373 ctx->cb (pfx, l3p->l3p_sw_if_index, ctx->ctx);
1376 return FIB_TABLE_WALK_CONTINUE;
1380 ip_container_proxy_walk (ip_container_proxy_cb_t cb, void *ctx)
1382 fib_table_t *fib_table;
1383 ip_container_proxy_walk_ctx_t wctx = {
1389 pool_foreach (fib_table, ip4_main.fibs,
1391 fib_table_walk(fib_table->ft_index,
1393 ip_container_proxy_fib_table_walk,
1396 pool_foreach (fib_table, ip6_main.fibs,
1398 fib_table_walk(fib_table->ft_index,
1400 ip_container_proxy_fib_table_walk,
1407 ip_container_cmd (vlib_main_t * vm,
1408 unformat_input_t * main_input, vlib_cli_command_t * cmd)
1410 unformat_input_t _line_input, *line_input = &_line_input;
1412 u32 is_del, addr_set = 0;
1416 vnm = vnet_get_main ();
1419 clib_memset (&pfx, 0, sizeof (pfx));
1421 /* Get a line of input. */
1422 if (!unformat_user (main_input, unformat_line_input, line_input))
1425 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1427 if (unformat (line_input, "%U", unformat_ip4_address, &pfx.fp_addr.ip4))
1429 pfx.fp_proto = FIB_PROTOCOL_IP4;
1433 else if (unformat (line_input, "%U",
1434 unformat_ip6_address, &pfx.fp_addr.ip6))
1436 pfx.fp_proto = FIB_PROTOCOL_IP6;
1440 else if (unformat (line_input, "%U",
1441 unformat_vnet_sw_interface, vnm, &sw_if_index))
1443 else if (unformat (line_input, "del"))
1447 unformat_free (line_input);
1448 return (clib_error_return (0, "unknown input '%U'",
1449 format_unformat_error, line_input));
1453 if (~0 == sw_if_index || !addr_set)
1455 unformat_free (line_input);
1456 vlib_cli_output (vm, "interface and address must be set");
1460 vnet_ip_container_proxy_args_t args = {
1462 .sw_if_index = sw_if_index,
1465 vnet_ip_container_proxy_add_del (&args);
1466 unformat_free (line_input);
1471 VLIB_CLI_COMMAND (ip_container_command_node, static) = {
1472 .path = "ip container",
1473 .function = ip_container_cmd,
1474 .short_help = "ip container <address> <interface>",
1480 show_ip_container_cmd_fn (vlib_main_t * vm, unformat_input_t * main_input,
1481 vlib_cli_command_t * cmd)
1483 unformat_input_t _line_input, *line_input = &_line_input;
1484 vnet_main_t *vnm = vnet_get_main ();
1486 u32 sw_if_index = ~0;
1489 if (!unformat_user (main_input, unformat_line_input, line_input))
1491 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1493 if (unformat (line_input, "%U", unformat_ip4_address, &pfx.fp_addr.ip4))
1495 pfx.fp_proto = FIB_PROTOCOL_IP4;
1498 else if (unformat (line_input, "%U",
1499 unformat_ip6_address, &pfx.fp_addr.ip6))
1501 pfx.fp_proto = FIB_PROTOCOL_IP6;
1504 else if (unformat (line_input, "%U",
1505 unformat_vnet_sw_interface, vnm, &sw_if_index))
1509 unformat_free (line_input);
1510 return (clib_error_return (0, "unknown input '%U'",
1511 format_unformat_error, line_input));
1515 if (~0 == sw_if_index)
1517 unformat_free (line_input);
1518 vlib_cli_output (vm, "no interface");
1519 return (clib_error_return (0, "no interface"));
1522 has_proxy = ip_container_proxy_is_set (&pfx, sw_if_index);
1523 vlib_cli_output (vm, "ip container proxy is: %s", has_proxy ? "on" : "off");
1525 unformat_free (line_input);
1530 VLIB_CLI_COMMAND (show_ip_container_command, static) = {
1531 .path = "show ip container",
1532 .function = show_ip_container_cmd_fn,
1533 .short_help = "show ip container <address> <interface>",
1539 * fd.io coding-style-patch-verification: ON
1542 * eval: (c-set-style "gnu")