2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ip/ip_lookup.c: ip4/6 adjacency and lookup table managment
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vnet/ip/ip.h>
41 #include <vnet/adj/adj.h>
42 #include <vnet/fib/fib_table.h>
43 #include <vnet/fib/ip4_fib.h>
44 #include <vnet/fib/ip6_fib.h>
45 #include <vnet/mpls/mpls.h>
46 #include <vnet/mfib/mfib_table.h>
47 #include <vnet/dpo/drop_dpo.h>
48 #include <vnet/dpo/classify_dpo.h>
49 #include <vnet/dpo/punt_dpo.h>
50 #include <vnet/dpo/receive_dpo.h>
51 #include <vnet/dpo/ip_null_dpo.h>
52 #include <vnet/ip/ip6_neighbor.h>
56 * @brief IPv4 and IPv6 adjacency and lookup table managment.
61 ip_interface_address_add_del (ip_lookup_main_t * lm,
65 u32 is_del, u32 * result_if_address_index)
67 vnet_main_t *vnm = vnet_get_main ();
68 ip_interface_address_t *a, *prev, *next;
69 uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
71 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
73 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
75 /* Verify given length. */
76 if ((a && (address_length != a->address_length)) ||
77 (address_length == 0) ||
78 (lm->is_ip6 && address_length > 128) ||
79 (!lm->is_ip6 && address_length > 32))
81 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
82 return clib_error_create
83 ("%U wrong length (expected %d) for interface %U",
84 lm->format_address_and_length, addr_fib,
85 address_length, a ? a->address_length : -1,
86 format_vnet_sw_if_index_name, vnm, sw_if_index);
93 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
94 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
95 return clib_error_create ("%U not found for interface %U",
96 lm->format_address_and_length,
97 addr_fib, address_length,
98 format_vnet_sw_interface_name, vnm, si);
101 if (a->prev_this_sw_interface != ~0)
104 pool_elt_at_index (lm->if_address_pool,
105 a->prev_this_sw_interface);
106 prev->next_this_sw_interface = a->next_this_sw_interface;
108 if (a->next_this_sw_interface != ~0)
111 pool_elt_at_index (lm->if_address_pool,
112 a->next_this_sw_interface);
113 next->prev_this_sw_interface = a->prev_this_sw_interface;
115 if (a->prev_this_sw_interface == ~0)
116 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
117 a->next_this_sw_interface;
120 if ((a->next_this_sw_interface == ~0)
121 && (a->prev_this_sw_interface == ~0))
122 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
124 mhash_unset (&lm->address_to_if_address_index, addr_fib,
126 pool_put (lm->if_address_pool, a);
128 if (result_if_address_index)
129 *result_if_address_index = ~0;
134 u32 pi; /* previous index */
136 u32 hi; /* head index */
138 pool_get (lm->if_address_pool, a);
139 memset (a, ~0, sizeof (a[0]));
140 ai = a - lm->if_address_pool;
142 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
144 while (pi != (u32) ~ 0)
146 prev = pool_elt_at_index (lm->if_address_pool, pi);
147 pi = prev->next_this_sw_interface;
149 pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
151 a->address_key = mhash_set (&lm->address_to_if_address_index,
152 addr_fib, ai, /* old_value */ 0);
153 a->address_length = address_length;
154 a->sw_if_index = sw_if_index;
156 a->prev_this_sw_interface = pi;
157 a->next_this_sw_interface = ~0;
159 prev->next_this_sw_interface = ai;
161 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
162 (hi != ~0) ? hi : ai;
163 if (result_if_address_index)
164 *result_if_address_index = ai;
168 if (result_if_address_index)
169 *result_if_address_index = a - lm->if_address_pool;
173 return /* no error */ 0;
176 static clib_error_t *
177 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
179 vec_validate_init_empty (ip4_main.
180 lookup_main.if_address_pool_index_by_sw_if_index,
182 vec_validate_init_empty (ip6_main.
183 lookup_main.if_address_pool_index_by_sw_if_index,
189 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
192 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
194 if (!lm->fib_result_n_bytes)
195 lm->fib_result_n_bytes = sizeof (uword);
200 lm->format_address_and_length = format_ip6_address_and_length;
201 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
202 sizeof (ip6_address_fib_t));
206 lm->format_address_and_length = format_ip4_address_and_length;
207 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
208 sizeof (ip4_address_fib_t));
214 /* Setup all IP protocols to be punted and builtin-unknown. */
215 for (i = 0; i < 256; i++)
217 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
218 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
221 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
222 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
223 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
224 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
225 IP_BUILTIN_PROTOCOL_UDP;
226 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
228 IP_BUILTIN_PROTOCOL_ICMP;
233 format_ip_flow_hash_config (u8 * s, va_list * args)
235 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
237 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
238 foreach_flow_hash_bit;
245 format_ip_lookup_next (u8 * s, va_list * args)
247 /* int promotion of ip_lookup_next_t */
248 ip_lookup_next_t n = va_arg (*args, int);
254 s = format (s, "unknown %d", n);
257 case IP_LOOKUP_NEXT_DROP:
260 case IP_LOOKUP_NEXT_PUNT:
263 case IP_LOOKUP_NEXT_ARP:
266 case IP_LOOKUP_NEXT_MIDCHAIN:
269 case IP_LOOKUP_NEXT_GLEAN:
272 case IP_LOOKUP_NEXT_MCAST:
275 case IP_LOOKUP_NEXT_REWRITE:
280 vec_add (s, t, strlen (t));
286 format_ip_adjacency_packet_data (u8 * s, va_list * args)
288 u32 adj_index = va_arg (*args, u32);
289 u8 *packet_data = va_arg (*args, u8 *);
290 u32 n_packet_data_bytes = va_arg (*args, u32);
291 ip_adjacency_t *adj = adj_get (adj_index);
293 switch (adj->lookup_next_index)
295 case IP_LOOKUP_NEXT_REWRITE:
296 case IP_LOOKUP_NEXT_MCAST:
298 format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
309 unformat_dpo (unformat_input_t * input, va_list * args)
311 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
312 fib_protocol_t fp = va_arg (*args, int);
315 proto = fib_proto_to_dpo (fp);
317 if (unformat (input, "drop"))
318 dpo_copy (dpo, drop_dpo_get (proto));
319 else if (unformat (input, "punt"))
320 dpo_copy (dpo, punt_dpo_get (proto));
321 else if (unformat (input, "local"))
322 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
323 else if (unformat (input, "null-send-unreach"))
324 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
325 else if (unformat (input, "null-send-prohibit"))
326 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
327 else if (unformat (input, "null"))
328 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
329 else if (unformat (input, "classify"))
331 u32 classify_table_index;
333 if (!unformat (input, "%d", &classify_table_index))
335 clib_warning ("classify adj must specify table index");
339 dpo_set (dpo, DPO_CLASSIFY, proto,
340 classify_dpo_create (proto, classify_table_index));
348 const ip46_address_t zero_addr = {
354 vnet_ip_route_cmd (vlib_main_t * vm,
355 unformat_input_t * main_input, vlib_cli_command_t * cmd)
357 unformat_input_t _line_input, *line_input = &_line_input;
358 fib_route_path_t *rpaths = NULL, rpath;
359 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
360 fib_prefix_t *prefixs = NULL, pfx;
361 mpls_label_t out_label, via_label;
362 clib_error_t *error = NULL;
363 u32 weight, preference;
364 u32 table_id, is_del;
370 vnm = vnet_get_main ();
374 memset (&pfx, 0, sizeof (pfx));
375 out_label = via_label = MPLS_LABEL_INVALID;
377 /* Get a line of input. */
378 if (!unformat_user (main_input, unformat_line_input, line_input))
381 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
383 memset (&rpath, 0, sizeof (rpath));
385 if (unformat (line_input, "table %d", &table_id))
387 else if (unformat (line_input, "resolve-via-host"))
389 if (vec_len (rpaths) == 0)
391 error = clib_error_return (0, "Paths then flags");
394 rpaths[vec_len (rpaths) - 1].frp_flags |=
395 FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
397 else if (unformat (line_input, "resolve-via-attached"))
399 if (vec_len (rpaths) == 0)
401 error = clib_error_return (0, "Paths then flags");
404 rpaths[vec_len (rpaths) - 1].frp_flags |=
405 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
407 else if (unformat (line_input, "out-labels"))
409 if (vec_len (rpaths) == 0)
411 error = clib_error_return (0, "Paths then labels");
416 while (unformat (line_input, "%U",
417 unformat_mpls_unicast_label, &out_label))
419 vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack,
424 else if (unformat (line_input, "via-label %U",
425 unformat_mpls_unicast_label, &rpath.frp_local_label))
427 rpath.frp_weight = 1;
428 rpath.frp_eos = MPLS_NON_EOS;
429 rpath.frp_proto = DPO_PROTO_MPLS;
430 rpath.frp_sw_if_index = ~0;
431 vec_add1 (rpaths, rpath);
433 else if (unformat (line_input, "count %f", &count))
436 else if (unformat (line_input, "%U/%d",
437 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
439 pfx.fp_proto = FIB_PROTOCOL_IP4;
440 vec_add1 (prefixs, pfx);
442 else if (unformat (line_input, "%U/%d",
443 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
445 pfx.fp_proto = FIB_PROTOCOL_IP6;
446 vec_add1 (prefixs, pfx);
448 else if (unformat (line_input, "via %U %U",
449 unformat_ip4_address,
451 unformat_vnet_sw_interface, vnm,
452 &rpath.frp_sw_if_index))
454 rpath.frp_weight = 1;
455 rpath.frp_proto = DPO_PROTO_IP4;
456 vec_add1 (rpaths, rpath);
459 else if (unformat (line_input, "via %U %U",
460 unformat_ip6_address,
462 unformat_vnet_sw_interface, vnm,
463 &rpath.frp_sw_if_index))
465 rpath.frp_weight = 1;
466 rpath.frp_proto = DPO_PROTO_IP6;
467 vec_add1 (rpaths, rpath);
469 else if (unformat (line_input, "weight %u", &weight))
471 ASSERT (vec_len (rpaths));
472 rpaths[vec_len (rpaths) - 1].frp_weight = weight;
474 else if (unformat (line_input, "preference %u", &preference))
476 ASSERT (vec_len (rpaths));
477 rpaths[vec_len (rpaths) - 1].frp_preference = preference;
479 else if (unformat (line_input, "via %U next-hop-table %d",
480 unformat_ip4_address,
481 &rpath.frp_addr.ip4, &rpath.frp_fib_index))
483 rpath.frp_weight = 1;
484 rpath.frp_sw_if_index = ~0;
485 rpath.frp_proto = DPO_PROTO_IP4;
486 vec_add1 (rpaths, rpath);
488 else if (unformat (line_input, "via %U next-hop-table %d",
489 unformat_ip6_address,
490 &rpath.frp_addr.ip6, &rpath.frp_fib_index))
492 rpath.frp_weight = 1;
493 rpath.frp_sw_if_index = ~0;
494 rpath.frp_proto = DPO_PROTO_IP6;
495 vec_add1 (rpaths, rpath);
497 else if (unformat (line_input, "via %U",
498 unformat_ip4_address, &rpath.frp_addr.ip4))
501 * the recursive next-hops are by default in the same table
504 rpath.frp_fib_index = table_id;
505 rpath.frp_weight = 1;
506 rpath.frp_sw_if_index = ~0;
507 rpath.frp_proto = DPO_PROTO_IP4;
508 vec_add1 (rpaths, rpath);
510 else if (unformat (line_input, "via %U",
511 unformat_ip6_address, &rpath.frp_addr.ip6))
513 rpath.frp_fib_index = table_id;
514 rpath.frp_weight = 1;
515 rpath.frp_sw_if_index = ~0;
516 rpath.frp_proto = DPO_PROTO_IP6;
517 vec_add1 (rpaths, rpath);
519 else if (unformat (line_input,
520 "lookup in table %d", &rpath.frp_fib_index))
522 rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
523 rpath.frp_sw_if_index = ~0;
524 vec_add1 (rpaths, rpath);
526 else if (vec_len (prefixs) > 0 &&
527 unformat (line_input, "via %U",
528 unformat_vnet_sw_interface, vnm,
529 &rpath.frp_sw_if_index))
531 rpath.frp_weight = 1;
532 rpath.frp_proto = fib_proto_to_dpo (prefixs[0].fp_proto);
533 vec_add1 (rpaths, rpath);
535 else if (vec_len (prefixs) > 0 &&
536 unformat (line_input, "via %U",
537 unformat_dpo, &dpo, prefixs[0].fp_proto))
539 vec_add1 (dpos, dpo);
541 else if (unformat (line_input, "del"))
543 else if (unformat (line_input, "add"))
547 error = unformat_parse_error (line_input);
552 if (vec_len (prefixs) == 0)
555 clib_error_return (0, "expected ip4/ip6 destination address/length.");
559 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
561 error = clib_error_return (0, "expected paths.");
568 * if no table_id is passed we will manipulate the default
574 fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
578 error = clib_error_return (0, "Nonexistent table id %d", table_id);
583 for (i = 0; i < vec_len (prefixs); i++)
585 if (is_del && 0 == vec_len (rpaths))
587 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
589 else if (!is_del && 1 == vec_len (dpos))
591 fib_table_entry_special_dpo_add (fib_index,
594 FIB_ENTRY_FLAG_EXCLUSIVE,
596 dpo_reset (&dpos[0]);
598 else if (vec_len (dpos) > 0)
601 clib_error_return (0,
602 "Load-balancing over multiple special adjacencies is unsupported");
605 else if (0 < vec_len (rpaths))
608 ip46_address_t dst = prefixs[i].fp_addr;
611 t[0] = vlib_time_now (vm);
612 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
615 for (k = 0; k < n; k++)
617 for (j = 0; j < vec_len (rpaths); j++)
621 * the CLI parsing stored table Ids, swap to FIB indicies
623 fi = fib_table_find (prefixs[i].fp_proto,
624 rpaths[i].frp_fib_index);
629 clib_error_return (0, "Via table %d does not exist",
630 rpaths[i].frp_fib_index);
633 rpaths[i].frp_fib_index = fi;
635 fib_prefix_t rpfx = {
636 .fp_len = prefixs[i].fp_len,
637 .fp_proto = prefixs[i].fp_proto,
642 fib_table_entry_path_remove2 (fib_index,
644 FIB_SOURCE_CLI, &rpaths[j]);
646 fib_table_entry_path_add2 (fib_index,
653 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
656 clib_host_to_net_u32 (incr +
657 clib_net_to_host_u32 (dst.
662 int bucket = (incr < 64 ? 0 : 1);
663 dst.ip6.as_u64[bucket] =
664 clib_host_to_net_u64 (incr +
665 clib_net_to_host_u64 (dst.ip6.as_u64
670 t[1] = vlib_time_now (vm);
672 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
676 error = clib_error_return (0, "Don't understand what you want...");
686 unformat_free (line_input);
691 vnet_ip_table_cmd (vlib_main_t * vm,
692 unformat_input_t * main_input,
693 vlib_cli_command_t * cmd, fib_protocol_t fproto)
695 unformat_input_t _line_input, *line_input = &_line_input;
696 clib_error_t *error = NULL;
697 u32 table_id, is_add;
702 /* Get a line of input. */
703 if (!unformat_user (main_input, unformat_line_input, line_input))
706 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
708 if (unformat (line_input, "%d", &table_id))
710 else if (unformat (line_input, "del"))
712 else if (unformat (line_input, "add"))
716 error = unformat_parse_error (line_input);
723 error = clib_error_return (0, "No table id");
726 else if (0 == table_id)
728 error = clib_error_return (0, "Can't change the default table");
735 ip_table_create (fproto, table_id, 0);
739 ip_table_delete (fproto, table_id, 0);
744 unformat_free (line_input);
749 vnet_ip4_table_cmd (vlib_main_t * vm,
750 unformat_input_t * main_input, vlib_cli_command_t * cmd)
752 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
756 vnet_ip6_table_cmd (vlib_main_t * vm,
757 unformat_input_t * main_input, vlib_cli_command_t * cmd)
759 return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
763 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
765 .short_help = "Internet protocol (IP) commands",
770 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
772 .short_help = "Internet protocol version 6 (IPv6) commands",
777 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
779 .short_help = "Internet protocol (IP) show commands",
784 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
786 .short_help = "Internet protocol version 6 (IPv6) show commands",
791 * This command is used to add or delete IPv4 or IPv6 routes. All
792 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
793 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
794 * can be IPv4 or IPv6, but all must be of the same form in a single
795 * command. To display the current set of routes, use the commands
796 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
799 * Example of how to add a straight forward static route:
800 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
801 * Example of how to delete a straight forward static route:
802 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
803 * Mainly for route add/del performance testing, one can add or delete
804 * multiple routes by adding 'count N' to the previous item:
805 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
806 * Add multiple routes for the same destination to create equal-cost multipath:
807 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
808 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
809 * For unequal-cost multipath, specify the desired weights. This
810 * combination of weights results in 3/4 of the traffic following the
811 * second path, 1/4 following the first path:
812 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
813 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
814 * To add a route to a particular FIB table (VRF), use:
815 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
818 VLIB_CLI_COMMAND (ip_route_command, static) = {
820 .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>]",
821 .function = vnet_ip_route_cmd,
827 * This command is used to add or delete IPv4 Tables. All
828 * Tables must be explicitly added before that can be used. Creating a
829 * table will add both unicast and multicast FIBs
833 VLIB_CLI_COMMAND (ip4_table_command, static) = {
835 .short_help = "ip table [add|del] <table-id>",
836 .function = vnet_ip4_table_cmd,
843 * This command is used to add or delete IPv4 Tables. All
844 * Tables must be explicitly added before that can be used. Creating a
845 * table will add both unicast and multicast FIBs
849 VLIB_CLI_COMMAND (ip6_table_command, static) = {
851 .short_help = "ip6 table [add|del] <table-id>",
852 .function = vnet_ip6_table_cmd,
856 static clib_error_t *
857 ip_table_bind_cmd (vlib_main_t * vm,
858 unformat_input_t * input,
859 vlib_cli_command_t * cmd,
860 fib_protocol_t fproto)
862 vnet_main_t *vnm = vnet_get_main ();
863 clib_error_t *error = 0;
864 u32 sw_if_index, table_id;
869 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
871 error = clib_error_return (0, "unknown interface `%U'",
872 format_unformat_error, input);
876 if (unformat (input, "%d", &table_id))
880 error = clib_error_return (0, "expected table id `%U'",
881 format_unformat_error, input);
885 rv = ip_table_bind (fproto, sw_if_index, table_id, 0);
887 if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
889 error = clib_error_return (0, "IP addresses are still present on %U",
890 format_vnet_sw_if_index_name,
894 else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
896 error = clib_error_return (0, "no such table %d", table_id);
900 error = clib_error_return (0, "unknown error");
907 static clib_error_t *
908 ip4_table_bind_cmd (vlib_main_t * vm,
909 unformat_input_t * input,
910 vlib_cli_command_t * cmd)
912 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP4));
915 static clib_error_t *
916 ip6_table_bind_cmd (vlib_main_t * vm,
917 unformat_input_t * input,
918 vlib_cli_command_t * cmd)
920 return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
924 * Place the indicated interface into the supplied IPv4 FIB table (also known
925 * as a VRF). If the FIB table does not exist, this command creates it. To
926 * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
927 * FIB table will only be displayed if a route has been added to the table, or
928 * an IP Address is assigned to an interface in the table (which adds a route
931 * @note IP addresses added after setting the interface IP table are added to
932 * the indicated FIB table. If an IP address is added prior to changing the
933 * table then this is an error. The control plane must remove these addresses
934 * first and then change the table. VPP will not automatically move the
935 * addresses from the old to the new table as it does not know the validity
939 * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
940 * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
943 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
945 .path = "set interface ip table",
946 .function = ip4_table_bind_cmd,
947 .short_help = "set interface ip table <interface> <table-id>",
952 * Place the indicated interface into the supplied IPv6 FIB table (also known
953 * as a VRF). If the FIB table does not exist, this command creates it. To
954 * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
955 * FIB table will only be displayed if a route has been added to the table, or
956 * an IP Address is assigned to an interface in the table (which adds a route
959 * @note IP addresses added after setting the interface IP table are added to
960 * the indicated FIB table. If an IP address is added prior to changing the
961 * table then this is an error. The control plane must remove these addresses
962 * first and then change the table. VPP will not automatically move the
963 * addresses from the old to the new table as it does not know the validity
967 * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
968 * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
971 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
973 .path = "set interface ip6 table",
974 .function = ip6_table_bind_cmd,
975 .short_help = "set interface ip6 table <interface> <table-id>"
980 vnet_ip_mroute_cmd (vlib_main_t * vm,
981 unformat_input_t * main_input, vlib_cli_command_t * cmd)
983 unformat_input_t _line_input, *line_input = &_line_input;
984 clib_error_t *error = NULL;
985 fib_route_path_t rpath;
986 u32 table_id, is_del;
990 mfib_itf_flags_t iflags = 0;
991 mfib_entry_flags_t eflags = 0;
992 u32 gcount, scount, ss, gg, incr;
996 vnm = vnet_get_main ();
999 memset (&pfx, 0, sizeof (pfx));
1000 memset (&rpath, 0, sizeof (rpath));
1001 rpath.frp_sw_if_index = ~0;
1003 /* Get a line of input. */
1004 if (!unformat_user (main_input, unformat_line_input, line_input))
1007 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1009 if (unformat (line_input, "table %d", &table_id))
1011 else if (unformat (line_input, "del"))
1013 else if (unformat (line_input, "add"))
1015 else if (unformat (line_input, "scount %d", &scount))
1017 else if (unformat (line_input, "gcount %d", &gcount))
1019 else if (unformat (line_input, "%U %U",
1020 unformat_ip4_address,
1021 &pfx.fp_src_addr.ip4,
1022 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1024 pfx.fp_proto = FIB_PROTOCOL_IP4;
1027 else if (unformat (line_input, "%U %U",
1028 unformat_ip6_address,
1029 &pfx.fp_src_addr.ip6,
1030 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1032 pfx.fp_proto = FIB_PROTOCOL_IP6;
1035 else if (unformat (line_input, "%U/%d",
1036 unformat_ip4_address,
1037 &pfx.fp_grp_addr.ip4, &pfx.fp_len))
1039 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1040 pfx.fp_proto = FIB_PROTOCOL_IP4;
1042 else if (unformat (line_input, "%U/%d",
1043 unformat_ip6_address,
1044 &pfx.fp_grp_addr.ip6, &pfx.fp_len))
1046 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1047 pfx.fp_proto = FIB_PROTOCOL_IP6;
1049 else if (unformat (line_input, "%U",
1050 unformat_ip4_address, &pfx.fp_grp_addr.ip4))
1052 memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
1053 pfx.fp_proto = FIB_PROTOCOL_IP4;
1056 else if (unformat (line_input, "%U",
1057 unformat_ip6_address, &pfx.fp_grp_addr.ip6))
1059 memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
1060 pfx.fp_proto = FIB_PROTOCOL_IP6;
1063 else if (unformat (line_input, "via %U",
1064 unformat_vnet_sw_interface, vnm,
1065 &rpath.frp_sw_if_index))
1067 rpath.frp_weight = 1;
1069 else if (unformat (line_input, "via local"))
1071 rpath.frp_sw_if_index = ~0;
1072 rpath.frp_weight = 1;
1073 rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
1075 else if (unformat (line_input, "%U", unformat_mfib_itf_flags, &iflags))
1077 else if (unformat (line_input, "%U",
1078 unformat_mfib_entry_flags, &eflags))
1082 error = unformat_parse_error (line_input);
1090 * if no table_id is passed we will manipulate the default
1096 fib_index = mfib_table_find (pfx.fp_proto, table_id);
1098 if (~0 == fib_index)
1100 error = clib_error_return (0, "Nonexistent table id %d", table_id);
1105 timet[0] = vlib_time_now (vm);
1107 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1109 incr = 1 << (32 - (pfx.fp_len % 32));
1113 incr = 1 << (128 - (pfx.fp_len % 128));
1116 for (ss = 0; ss < scount; ss++)
1118 for (gg = 0; gg < gcount; gg++)
1120 if (is_del && 0 == rpath.frp_weight)
1122 /* no path provided => route delete */
1123 mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
1127 mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
1128 MFIB_RPF_ID_NONE, eflags);
1133 mfib_table_entry_path_remove (fib_index,
1134 &pfx, MFIB_SOURCE_CLI, &rpath);
1136 mfib_table_entry_path_update (fib_index,
1137 &pfx, MFIB_SOURCE_CLI, &rpath,
1141 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1143 pfx.fp_grp_addr.ip4.as_u32 =
1144 clib_host_to_net_u32 (incr +
1145 clib_net_to_host_u32 (pfx.
1151 int bucket = (incr < 64 ? 0 : 1);
1152 pfx.fp_grp_addr.ip6.as_u64[bucket] =
1153 clib_host_to_net_u64 (incr +
1154 clib_net_to_host_u64 (pfx.
1155 fp_grp_addr.ip6.as_u64
1160 if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
1162 pfx.fp_src_addr.ip4.as_u32 =
1163 clib_host_to_net_u32 (1 +
1164 clib_net_to_host_u32 (pfx.fp_src_addr.
1169 pfx.fp_src_addr.ip6.as_u64[1] =
1170 clib_host_to_net_u64 (1 +
1171 clib_net_to_host_u64 (pfx.fp_src_addr.
1176 timet[1] = vlib_time_now (vm);
1178 if (scount > 1 || gcount > 1)
1179 vlib_cli_output (vm, "%.6e routes/sec",
1180 (scount * gcount) / (timet[1] - timet[0]));
1183 unformat_free (line_input);
1189 * This command is used to add or delete IPv4 or IPv6 multicastroutes. All
1190 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
1191 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
1192 * can be IPv4 or IPv6, but all must be of the same form in a single
1193 * command. To display the current set of routes, use the commands
1194 * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
1195 * The full set of support flags for interfaces and route is shown via;
1196 * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
1199 * Example of how to add a forwarding interface to a route (and create the
1200 * route if it does not exist)
1201 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
1202 * Example of how to add an accepting interface to a route (and create the
1203 * route if it does not exist)
1204 * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
1205 * Example of changing the route's flags to send signals via the API
1206 * @cliexcmd{ip mroute add 232.1.1.1 Signal}
1210 VLIB_CLI_COMMAND (ip_mroute_command, static) =
1212 .path = "ip mroute",
1213 .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>],",
1214 .function = vnet_ip_mroute_cmd,
1220 * The next two routines address a longstanding script hemorrhoid.
1221 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1222 * or dependent route-adds will simply fail.
1224 static clib_error_t *
1225 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
1228 vnet_main_t *vnm = vnet_get_main ();
1233 uword *event_data = 0;
1235 ASSERT (vlib_in_process_context (vm));
1237 if (retry_count > 0)
1238 vnet_register_ip6_neighbor_resolution_event
1239 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1240 1 /* event */ , 0 /* data */ );
1242 for (i = 0; i < retry_count; i++)
1244 /* The interface may be down, etc. */
1245 e = ip6_probe_neighbor (vm, a, sw_if_index);
1250 vlib_process_wait_for_event_or_clock (vm, 1.0);
1251 event_type = vlib_process_get_events (vm, &event_data);
1254 case 1: /* resolved... */
1255 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
1259 case ~0: /* timeout */
1263 clib_warning ("unknown event_type %d", event_type);
1265 vec_reset_length (event_data);
1271 return clib_error_return (0, "Resolution failed for %U",
1272 format_ip6_address, a);
1276 static clib_error_t *
1277 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
1280 vnet_main_t *vnm = vnet_get_main ();
1285 uword *event_data = 0;
1287 ASSERT (vlib_in_process_context (vm));
1289 if (retry_count > 0)
1290 vnet_register_ip4_arp_resolution_event
1291 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1292 1 /* event */ , 0 /* data */ );
1294 for (i = 0; i < retry_count; i++)
1296 /* The interface may be down, etc. */
1297 e = ip4_probe_neighbor (vm, a, sw_if_index);
1302 vlib_process_wait_for_event_or_clock (vm, 1.0);
1303 event_type = vlib_process_get_events (vm, &event_data);
1306 case 1: /* resolved... */
1307 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
1311 case ~0: /* timeout */
1315 clib_warning ("unknown event_type %d", event_type);
1317 vec_reset_length (event_data);
1322 vec_reset_length (event_data);
1325 return clib_error_return (0, "Resolution failed for %U",
1326 format_ip4_address, a);
1330 static clib_error_t *
1331 probe_neighbor_address (vlib_main_t * vm,
1332 unformat_input_t * input, vlib_cli_command_t * cmd)
1334 vnet_main_t *vnm = vnet_get_main ();
1335 unformat_input_t _line_input, *line_input = &_line_input;
1338 clib_error_t *error = 0;
1339 u32 sw_if_index = ~0;
1340 int retry_count = 3;
1342 int address_set = 0;
1344 /* Get a line of input. */
1345 if (!unformat_user (input, unformat_line_input, line_input))
1348 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1350 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1353 else if (unformat (line_input, "retry %d", &retry_count))
1356 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1358 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1365 error = clib_error_return (0, "unknown input '%U'",
1366 format_unformat_error, line_input);
1371 if (sw_if_index == ~0)
1373 error = clib_error_return (0, "Interface required, not set.");
1376 if (address_set == 0)
1378 error = clib_error_return (0, "ip address required, not set.");
1381 if (address_set > 1)
1383 error = clib_error_return (0, "Multiple ip addresses not supported.");
1388 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1390 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1393 unformat_free (line_input);
1399 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
1400 * attempts IPv6 neighbor discovery depending on the supplied IP address
1403 * @note This command will not immediately affect the indicated FIB; it
1404 * is not suitable for use in establishing a FIB entry prior to adding
1405 * recursive FIB entries. As in: don't use it in a script to probe a
1406 * gateway prior to adding a default route. It won't work. Instead,
1407 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
1408 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
1411 * Example of probe for an IPv4 address:
1412 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
1415 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1416 .path = "ip probe-neighbor",
1417 .function = probe_neighbor_address,
1418 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
1424 * fd.io coding-style-patch-verification: ON
1427 * eval: (c-set-style "gnu")