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 * interface_cli.c: interface CLI
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.
41 * @brief Interface CLI.
43 * Source code for several CLI interface commands.
46 #include <vnet/vnet.h>
47 #include <vnet/ip/ip.h>
48 #include <vppinfra/bitmap.h>
49 #include <vnet/fib/ip4_fib.h>
50 #include <vnet/fib/ip6_fib.h>
51 #include <vnet/l2/l2_output.h>
52 #include <vnet/l2/l2_input.h>
53 #include <vnet/classify/vnet_classify.h>
54 #include <vnet/interface/rx_queue_funcs.h>
55 #include <vnet/interface/tx_queue_funcs.h>
57 compare_interface_names (void *a1, void *a2)
62 return vnet_hw_interface_compare (vnet_get_main (), *hi1, *hi2);
66 show_or_clear_hw_interfaces (vlib_main_t * vm,
67 unformat_input_t * input,
68 vlib_cli_command_t * cmd, int is_show)
70 clib_error_t *error = 0;
71 vnet_main_t *vnm = vnet_get_main ();
72 vnet_interface_main_t *im = &vnm->interface_main;
73 vnet_hw_interface_t *hi;
74 u32 hw_if_index, *hw_if_indices = 0;
75 int i, verbose = -1, show_bond = 0;
77 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
79 /* See if user wants to show a specific interface. */
81 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
82 vec_add1 (hw_if_indices, hw_if_index);
84 /* See if user wants to show an interface with a specific hw_if_index. */
85 else if (unformat (input, "%u", &hw_if_index))
86 vec_add1 (hw_if_indices, hw_if_index);
88 else if (unformat (input, "verbose"))
89 verbose = 1; /* this is also the default */
91 else if (unformat (input, "detail"))
94 else if (unformat (input, "brief"))
97 else if (unformat (input, "bond"))
101 verbose = 0; /* default to brief for link bonding */
106 error = clib_error_return (0, "unknown input `%U'",
107 format_unformat_error, input);
112 /* Gather interfaces. */
113 if (vec_len (hw_if_indices) == 0)
114 pool_foreach (hi, im->hw_interfaces)
115 vec_add1 (hw_if_indices, hi - im->hw_interfaces);
118 verbose = 1; /* default to verbose (except bond) */
123 vec_sort_with_function (hw_if_indices, compare_interface_names);
125 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm, 0, verbose);
126 for (i = 0; i < vec_len (hw_if_indices); i++)
128 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
129 if (show_bond == 0) /* show all interfaces */
130 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
132 else if ((hi->bond_info) &&
133 (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
134 { /* show only bonded interface and all its slave interfaces */
136 vnet_hw_interface_t *shi;
137 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
141 clib_bitmap_foreach (hw_idx, hi->bond_info)
143 shi = vnet_get_hw_interface(vnm, hw_idx);
144 vlib_cli_output (vm, "%U\n",
145 format_vnet_hw_interface, vnm, shi, verbose);
153 for (i = 0; i < vec_len (hw_if_indices); i++)
155 vnet_device_class_t *dc;
157 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
158 dc = vec_elt_at_index (im->device_classes, hi->dev_class_index);
160 if (dc->clear_counters)
161 dc->clear_counters (hi->dev_instance);
166 vec_free (hw_if_indices);
170 static clib_error_t *
171 show_hw_interfaces (vlib_main_t * vm,
172 unformat_input_t * input, vlib_cli_command_t * cmd)
174 return show_or_clear_hw_interfaces (vm, input, cmd, 1 /* is_show */ );
177 static clib_error_t *
178 clear_hw_interfaces (vlib_main_t * vm,
179 unformat_input_t * input, vlib_cli_command_t * cmd)
181 return show_or_clear_hw_interfaces (vm, input, cmd, 0 /* is_show */ );
186 * Display more detailed information about all or a list of given interfaces.
187 * The verboseness of the output can be controlled by the following optional
189 * - brief: Only show name, index and state (default for bonded interfaces).
190 * - verbose: Also display additional attributes (default for all other interfaces).
191 * - detail: Also display all remaining attributes and extended statistics.
193 * To limit the output of the command to bonded interfaces and their slave
194 * interfaces, use the '<em>bond</em>' optional parameter.
197 * Example of how to display default data for all interfaces:
198 * @cliexstart{show hardware-interfaces}
199 * Name Idx Link Hardware
200 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
201 * Ethernet address ec:f4:bb:c0:bc:fc
203 * carrier up full duplex speed 1000 mtu 9216
204 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
206 * GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
207 * Ethernet address ec:f4:bb:c0:bc:fd
209 * carrier up full duplex speed 1000 mtu 9216
210 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
212 * VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
213 * Ethernet address 02:fe:a5:a9:8b:8e
214 * VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
215 * Ethernet address 02:fe:c0:4e:3b:b0
216 * VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
217 * Ethernet address 02:fe:1f:73:92:81
218 * VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
219 * Ethernet address 02:fe:f2:25:c4:68
220 * local0 0 down local0
223 * Example of how to display '<em>verbose</em>' data for an interface by name and
224 * software index (where 2 is the software index):
225 * @cliexstart{show hardware-interfaces GigabitEthernet7/0/0 2 verbose}
226 * Name Idx Link Hardware
227 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
228 * Ethernet address ec:f4:bb:c0:bc:fc
230 * carrier up full duplex speed 1000 mtu 9216
231 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
233 * GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
234 * Ethernet address ec:f4:bb:c0:bc:fd
236 * carrier up full duplex speed 1000 mtu 9216
237 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
242 VLIB_CLI_COMMAND (show_hw_interfaces_command, static) = {
243 .path = "show hardware-interfaces",
244 .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] "
245 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
246 .function = show_hw_interfaces,
252 * Clear the extended statistics for all or a list of given interfaces
253 * (statistics associated with the '<em>show hardware-interfaces</em>' command).
256 * Example of how to clear the extended statistics for all interfaces:
257 * @cliexcmd{clear hardware-interfaces}
258 * Example of how to clear the extended statistics for an interface by
259 * name and software index (where 2 is the software index):
260 * @cliexcmd{clear hardware-interfaces GigabitEthernet7/0/0 2}
263 VLIB_CLI_COMMAND (clear_hw_interface_counters_command, static) = {
264 .path = "clear hardware-interfaces",
265 .short_help = "clear hardware-interfaces "
266 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
267 .function = clear_hw_interfaces,
272 sw_interface_name_compare (void *a1, void *a2)
274 vnet_sw_interface_t *si1 = a1;
275 vnet_sw_interface_t *si2 = a2;
277 return vnet_sw_interface_compare (vnet_get_main (),
278 si1->sw_if_index, si2->sw_if_index);
281 static clib_error_t *
282 show_sw_interfaces (vlib_main_t * vm,
283 unformat_input_t * input, vlib_cli_command_t * cmd)
285 clib_error_t *error = 0;
286 vnet_main_t *vnm = vnet_get_main ();
287 unformat_input_t _linput, *linput = &_linput;
288 vnet_interface_main_t *im = &vnm->interface_main;
289 vnet_sw_interface_t *si, *sorted_sis = 0;
290 u32 sw_if_index = ~(u32) 0;
291 u8 show_addresses = 0;
292 u8 show_features = 0;
298 * Get a line of input. Won't work if the user typed
299 * "show interface" and nothing more.
301 if (unformat_user (input, unformat_line_input, linput))
303 while (unformat_check_input (linput) != UNFORMAT_END_OF_INPUT)
305 /* See if user wants to show specific interface */
307 (linput, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
309 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
310 vec_add1 (sorted_sis, si[0]);
312 else if (unformat (linput, "address") || unformat (linput, "addr"))
314 else if (unformat (linput, "features") || unformat (linput, "feat"))
316 else if (unformat (linput, "tag"))
318 else if (unformat (linput, "vtr"))
320 else if (unformat (linput, "verbose"))
322 else if (unformat (linput, "%d", &sw_if_index))
324 if (!pool_is_free_index (im->sw_interfaces, sw_if_index))
326 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
327 vec_add1 (sorted_sis, si[0]);
331 vec_free (sorted_sis);
332 error = clib_error_return (0, "unknown interface index `%d'",
339 vec_free (sorted_sis);
340 error = clib_error_return (0, "unknown input `%U'",
341 format_unformat_error, linput);
345 unformat_free (linput);
347 if (show_features || show_tag || show_vtr)
349 if (sw_if_index == ~(u32) 0)
351 vec_free (sorted_sis);
352 return clib_error_return (0, "Interface not specified...");
358 vnet_interface_features_show (vm, sw_if_index, verbose);
359 vlib_cli_output (vm, "%U", format_l2_input_features, sw_if_index, 1);
361 l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
362 vlib_cli_output (vm, "\nl2-output:");
363 if (l2_output->out_vtr_flag)
364 vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
365 vlib_cli_output (vm, "%U", format_l2_output_features,
366 l2_output->feature_bitmap, 1);
367 vec_free (sorted_sis);
373 tag = vnet_get_sw_interface_tag (vnm, sw_if_index);
374 vlib_cli_output (vm, "%U: %s",
375 format_vnet_sw_if_index_name, vnm, sw_if_index,
376 tag ? (char *) tag : "(none)");
377 vec_free (sorted_sis);
382 * Show vlan tag rewrite data for one interface.
386 u32 vtr_op = L2_VTR_DISABLED;
387 u32 push_dot1q = 0, tag1 = 0, tag2 = 0;
389 if (l2vtr_get (vm, vnm, sw_if_index,
390 &vtr_op, &push_dot1q, &tag1, &tag2) != 0)
392 vlib_cli_output (vm, "%U: Problem getting vlan tag-rewrite data",
393 format_vnet_sw_if_index_name, vnm, sw_if_index);
396 vlib_cli_output (vm, "%U: VTR %0U",
397 format_vnet_sw_if_index_name, vnm, sw_if_index,
398 format_vtr, vtr_op, push_dot1q, tag1, tag2);
403 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, 0);
405 if (vec_len (sorted_sis) == 0) /* Get all interfaces */
407 /* Gather interfaces. */
409 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
410 _vec_len (sorted_sis) = 0;
412 pool_foreach (si, im->sw_interfaces)
414 int visible = vnet_swif_is_api_visible (si);
416 vec_add1 (sorted_sis, si[0]);
420 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
425 vec_foreach (si, sorted_sis)
427 ip4_main_t *im4 = &ip4_main;
428 ip6_main_t *im6 = &ip6_main;
429 ip_lookup_main_t *lm4 = &im4->lookup_main;
430 ip_lookup_main_t *lm6 = &im6->lookup_main;
431 ip_interface_address_t *ia = 0;
432 u32 fib_index4 = 0, fib_index6 = 0;
434 if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
435 fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
438 if (vec_len (im6->fib_index_by_sw_if_index) > si->sw_if_index)
439 fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
442 ip4_fib_t *fib4 = ip4_fib_get (fib_index4);
443 ip6_fib_t *fib6 = ip6_fib_get (fib_index6);
445 if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
447 (vm, "%U (%s): \n unnumbered, use %U",
448 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
449 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
450 format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
454 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
455 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn");
457 /* Display any L2 info */
458 vlib_cli_output (vm, "%U", format_l2_input, si->sw_if_index);
461 /* Display any IP4 addressing info */
462 foreach_ip_interface_address (lm4, ia, si->sw_if_index,
463 1 /* honor unnumbered */,
465 ip4_address_t *r4 = ip_interface_address_get_address (lm4, ia);
466 if (fib4->hash.table_id)
468 vm, " L3 %U/%d ip4 table-id %d fib-idx %d", format_ip4_address,
469 r4, ia->address_length, fib4->hash.table_id,
470 ip4_fib_index_from_table_id (fib4->hash.table_id));
472 vlib_cli_output (vm, " L3 %U/%d",
473 format_ip4_address, r4, ia->address_length);
478 /* Display any IP6 addressing info */
479 foreach_ip_interface_address (lm6, ia, si->sw_if_index,
480 1 /* honor unnumbered */,
482 ip6_address_t *r6 = ip_interface_address_get_address (lm6, ia);
484 vlib_cli_output (vm, " L3 %U/%d ip6 table-id %d fib-idx %d",
485 format_ip6_address, r6, ia->address_length,
487 ip6_fib_index_from_table_id (fib6->table_id));
489 vlib_cli_output (vm, " L3 %U/%d",
490 format_ip6_address, r6, ia->address_length);
497 vec_foreach (si, sorted_sis)
499 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, si);
504 vec_free (sorted_sis);
509 VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
510 .path = "show interface",
511 .short_help = "show interface [address|addr|features|feat|vtr] [<interface> [<interface> [..]]] [verbose]",
512 .function = show_sw_interfaces,
517 /* Root of all interface commands. */
519 VLIB_CLI_COMMAND (vnet_cli_interface_command, static) = {
521 .short_help = "Interface commands",
526 VLIB_CLI_COMMAND (vnet_cli_set_interface_command, static) = {
527 .path = "set interface",
528 .short_help = "Interface commands",
532 static clib_error_t *
533 clear_interface_counters (vlib_main_t * vm,
534 unformat_input_t * input, vlib_cli_command_t * cmd)
536 vnet_main_t *vnm = vnet_get_main ();
537 vnet_interface_main_t *im = &vnm->interface_main;
538 vlib_simple_counter_main_t *sm;
539 vlib_combined_counter_main_t *cm;
542 n_counters = vec_len (im->combined_sw_if_counters);
544 for (j = 0; j < n_counters; j++)
546 im = &vnm->interface_main;
547 cm = im->combined_sw_if_counters + j;
548 vlib_clear_combined_counters (cm);
551 n_counters = vec_len (im->sw_if_counters);
553 for (j = 0; j < n_counters; j++)
555 im = &vnm->interface_main;
556 sm = im->sw_if_counters + j;
557 vlib_clear_simple_counters (sm);
564 * Clear the statistics for all interfaces (statistics associated with the
565 * '<em>show interface</em>' command).
568 * Example of how to clear the statistics for all interfaces:
569 * @cliexcmd{clear interfaces}
572 VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
573 .path = "clear interfaces",
574 .short_help = "clear interfaces",
575 .function = clear_interface_counters,
580 * Parse subinterface names.
582 * The following subinterface syntax is supported. The first two are for
583 * backwards compatability:
586 * - a subinterface with the name <intf-name>.<id>. The subinterface
587 * is a single dot1q vlan with vlan id <id> and exact-match semantics.
589 * <intf-name> <min_id>-<max_id>
590 * - a set of the above subinterfaces, repeating for each id
591 * in the range <min_id> to <max_id>
593 * In the following, exact-match semantics (i.e. the number of vlan tags on the
594 * packet must match the number of tags in the configuration) are used only if
595 * the keyword exact-match is present. Non-exact match is the default.
597 * <intf-name> <id> dot1q <outer_id> [exact-match]
598 * - a subinterface with the name <intf-name>.<id>. The subinterface
599 * is a single dot1q vlan with vlan id <outer_id>.
601 * <intf-name> <id> dot1q any [exact-match]
602 * - a subinterface with the name <intf-name>.<id>. The subinterface
603 * is a single dot1q vlan with any vlan id.
605 * <intf-name> <id> dot1q <outer_id> inner-dot1q <inner_id> [exact-match]
606 * - a subinterface with the name <intf-name>.<id>. The subinterface
607 * is a double dot1q vlan with outer vlan id <outer_id> and inner vlan id
610 * <intf-name> <id> dot1q <outer_id> inner-dot1q any [exact-match]
611 * - a subinterface with the name <intf-name>.<id>. The subinterface
612 * is a double dot1q vlan with outer vlan id <id> and any inner vlan id.
614 * <intf-name> <id> dot1q any inner-dot1q any [exact-match]
616 * - a subinterface with the name <intf-name>.<id>. The subinterface
617 * is a double dot1q vlan with any outer vlan id and any inner vlan id.
619 * For each of the above CLI, there is a duplicate that uses the keyword
620 * "dot1ad" in place of the first "dot1q". These interfaces use ethertype
621 * 0x88ad in place of 0x8100 for the outer ethertype. Note that for double-
622 * tagged packets the inner ethertype is always 0x8100. Also note that
623 * the dot1q and dot1ad naming spaces are independent, so it is legal to
624 * have both "Gig3/0/0.1 dot1q 100" and "Gig3/0/0.2 dot1ad 100". For example:
626 * <intf-name> <id> dot1ad <outer_id> inner-dot1q <inner_id> [exact-match]
627 * - a subinterface with the name <intf-name>.<id>. The subinterface
628 * is a double dot1ad vlan with outer vlan id <outer_id> and inner vlan
631 * <intf-name> <id> untagged
632 * - a subinterface with the name <intf-name>.<id>. The subinterface
633 * has no vlan tags. Only one can be specified per interface.
635 * <intf-name> <id> default
636 * - a subinterface with the name <intf-name>.<id>. This is associated
637 * with a packet that did not match any other configured subinterface
638 * on this interface. Only one can be specified per interface.
641 static clib_error_t *
642 parse_vlan_sub_interfaces (unformat_input_t * input,
643 vnet_sw_interface_t * template)
645 clib_error_t *error = 0;
646 u32 inner_vlan, outer_vlan;
648 if (unformat (input, "any inner-dot1q any"))
650 template->sub.eth.flags.two_tags = 1;
651 template->sub.eth.flags.outer_vlan_id_any = 1;
652 template->sub.eth.flags.inner_vlan_id_any = 1;
654 else if (unformat (input, "any"))
656 template->sub.eth.flags.one_tag = 1;
657 template->sub.eth.flags.outer_vlan_id_any = 1;
659 else if (unformat (input, "%d inner-dot1q any", &outer_vlan))
661 template->sub.eth.flags.two_tags = 1;
662 template->sub.eth.flags.inner_vlan_id_any = 1;
663 template->sub.eth.outer_vlan_id = outer_vlan;
665 else if (unformat (input, "%d inner-dot1q %d", &outer_vlan, &inner_vlan))
667 template->sub.eth.flags.two_tags = 1;
668 template->sub.eth.outer_vlan_id = outer_vlan;
669 template->sub.eth.inner_vlan_id = inner_vlan;
671 else if (unformat (input, "%d", &outer_vlan))
673 template->sub.eth.flags.one_tag = 1;
674 template->sub.eth.outer_vlan_id = outer_vlan;
678 error = clib_error_return (0, "expected dot1q config, got `%U'",
679 format_unformat_error, input);
683 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
685 if (unformat (input, "exact-match"))
687 template->sub.eth.flags.exact_match = 1;
695 static clib_error_t *
696 create_sub_interfaces (vlib_main_t * vm,
697 unformat_input_t * input, vlib_cli_command_t * cmd)
699 vnet_main_t *vnm = vnet_get_main ();
700 clib_error_t *error = 0;
701 u32 hw_if_index, sw_if_index;
702 vnet_hw_interface_t *hi;
703 u32 id, id_min, id_max;
704 vnet_sw_interface_t template;
707 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
709 error = clib_error_return (0, "unknown interface `%U'",
710 format_unformat_error, input);
714 clib_memset (&template, 0, sizeof (template));
715 template.sub.eth.raw_flags = 0;
717 if (unformat (input, "%d default", &id_min))
720 template.sub.eth.flags.default_sub = 1;
722 else if (unformat (input, "%d untagged", &id_min))
725 template.sub.eth.flags.no_tags = 1;
726 template.sub.eth.flags.exact_match = 1;
728 else if (unformat (input, "%d dot1q", &id_min))
730 /* parse dot1q config */
732 error = parse_vlan_sub_interfaces (input, &template);
736 else if (unformat (input, "%d dot1ad", &id_min))
738 /* parse dot1ad config */
740 template.sub.eth.flags.dot1ad = 1;
741 error = parse_vlan_sub_interfaces (input, &template);
745 else if (unformat (input, "%d-%d", &id_min, &id_max))
747 template.sub.eth.flags.one_tag = 1;
748 template.sub.eth.flags.exact_match = 1;
752 else if (unformat (input, "%d", &id_min))
755 template.sub.eth.flags.one_tag = 1;
756 template.sub.eth.outer_vlan_id = id_min;
757 template.sub.eth.flags.exact_match = 1;
762 error = clib_error_return (0, "expected ID or ID MIN-MAX, got `%U'",
763 format_unformat_error, input);
767 hi = vnet_get_hw_interface (vnm, hw_if_index);
769 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
772 clib_error_return (0,
773 "not allowed as %v belong to a BondEthernet interface",
778 for (id = id_min; id <= id_max; id++)
781 vnet_interface_main_t *im = &vnm->interface_main;
782 u64 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
785 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
789 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
790 hi->sw_if_index, id);
794 template.type = VNET_SW_INTERFACE_TYPE_SUB;
795 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
796 template.sup_sw_if_index = hi->sw_if_index;
797 template.sub.id = id;
799 template.sub.eth.outer_vlan_id = id;
801 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
805 kp = clib_mem_alloc (sizeof (*kp));
806 *kp = sup_and_sub_key;
808 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
809 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
810 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
811 vnet_get_main (), sw_if_index);
819 * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
820 * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
821 * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
822 * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
823 * but this is not recommended.
825 * This command has several variations:
826 * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
827 * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
829 * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
830 * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
831 * match any other subinterfaces should be sent to this subinterface.
833 * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
834 * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
835 * to this subinterface.
837 * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
838 * subinterfaces to handle a range of VLAN IDs.
840 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
841 * Use this command to specify the outer VLAN ID, to either be explicit or to make the
842 * VLAN ID different from the '<em>subId</em>'.
844 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
845 * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
848 * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explicitly entered, subinterfaces
849 * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
850 * default. If '<em>exact-match</em>' is specified, packets must have the same number of
851 * VLAN tags as the configuration. For non-exact-match, packets must at least that number
852 * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
853 * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
854 * entered, then the default behavior is exact-match.
856 * Use the '<em>show interface</em>' command to display all subinterfaces.
860 * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
861 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
863 * The previous example is shorthand and is equivalent to:
864 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
867 * Example of how to create a subinterface number that is different from the VLAN ID:
868 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
871 * Examples of how to create q-in-q and q-in-any subinterfaces:
872 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
873 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
875 * Examples of how to create dot1ad interfaces:
876 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
877 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
880 * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
881 * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
882 * is non-exact match:
883 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
885 * However, the same packet would NOT match this interface because '<em>exact-match</em>'
886 * is specified and only one VLAN is configured, but packet contains two VLANs:
887 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
890 * Example of how to created a subinterface to process untagged packets:
891 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
893 * Example of how to created a subinterface to process any packet with a VLAN ID that
894 * does not match any other subinterface:
895 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
897 * When subinterfaces are created, they are in the down state. Example of how to
898 * enable a newly created subinterface:
899 * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
903 VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
904 .path = "create sub-interfaces",
905 .short_help = "create sub-interfaces <interface> "
906 "{<subId> [default|untagged]} | "
907 "{<subId>-<subId>} | "
908 "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
909 .function = create_sub_interfaces,
913 static clib_error_t *
914 set_state (vlib_main_t * vm,
915 unformat_input_t * input, vlib_cli_command_t * cmd)
917 vnet_main_t *vnm = vnet_get_main ();
919 u32 sw_if_index, flags;
922 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
924 error = clib_error_return (0, "unknown interface `%U'",
925 format_unformat_error, input);
929 if (!unformat (input, "%U", unformat_vnet_sw_interface_flags, &flags))
931 error = clib_error_return (0, "unknown flags `%U'",
932 format_unformat_error, input);
936 error = vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
946 * This command is used to change the admin state (up/down) of an interface.
948 * If an interface is down, the optional '<em>punt</em>' flag can also be set.
949 * The '<em>punt</em>' flag implies the interface is disabled for forwarding
950 * but punt all traffic to slow-path. Use the '<em>enable</em>' flag to clear
951 * '<em>punt</em>' flag (interface is still down).
954 * Example of how to configure the admin state of an interface to '<em>up</em?':
955 * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
956 * Example of how to configure the admin state of an interface to '<em>down</em?':
957 * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
960 VLIB_CLI_COMMAND (set_state_command, static) = {
961 .path = "set interface state",
962 .short_help = "set interface state <interface> [up|down|punt|enable]",
963 .function = set_state,
967 static clib_error_t *
968 set_unnumbered (vlib_main_t * vm,
969 unformat_input_t * input, vlib_cli_command_t * cmd)
971 vnet_main_t *vnm = vnet_get_main ();
972 u32 unnumbered_sw_if_index = ~0;
973 u32 inherit_from_sw_if_index = ~0;
976 if (unformat (input, "%U use %U",
977 unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
978 unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
980 else if (unformat (input, "del %U",
981 unformat_vnet_sw_interface, vnm,
982 &unnumbered_sw_if_index))
985 return clib_error_return (0, "parse error '%U'",
986 format_unformat_error, input);
988 if (~0 == unnumbered_sw_if_index)
989 return clib_error_return (0, "Specify the unnumbered interface");
990 if (enable && ~0 == inherit_from_sw_if_index)
991 return clib_error_return (0, "When enabling unnumbered specify the"
992 " IP enabled interface that it uses");
994 int rv = vnet_sw_interface_update_unnumbered (
995 unnumbered_sw_if_index, inherit_from_sw_if_index, enable);
1002 case VNET_API_ERROR_UNEXPECTED_INTF_STATE:
1003 return clib_error_return (
1005 "When enabling unnumbered both interfaces must be in the same tables");
1008 return clib_error_return (
1009 0, "vnet_sw_interface_update_unnumbered returned %d", rv);
1016 VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
1017 .path = "set interface unnumbered",
1018 .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
1019 .function = set_unnumbered,
1025 static clib_error_t *
1026 set_hw_class (vlib_main_t * vm,
1027 unformat_input_t * input, vlib_cli_command_t * cmd)
1029 vnet_main_t *vnm = vnet_get_main ();
1030 vnet_interface_main_t *im = &vnm->interface_main;
1031 clib_error_t *error;
1032 u32 hw_if_index, hw_class_index;
1035 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1037 error = clib_error_return (0, "unknown hardware interface `%U'",
1038 format_unformat_error, input);
1042 if (!unformat_user (input, unformat_hash_string,
1043 im->hw_interface_class_by_name, &hw_class_index))
1045 error = clib_error_return (0, "unknown hardware class `%U'",
1046 format_unformat_error, input);
1050 error = vnet_hw_interface_set_class (vnm, hw_if_index, hw_class_index);
1059 VLIB_CLI_COMMAND (set_hw_class_command, static) = {
1060 .path = "set interface hw-class",
1061 .short_help = "Set interface hardware class",
1062 .function = set_hw_class,
1066 static clib_error_t *
1067 vnet_interface_cli_init (vlib_main_t * vm)
1072 VLIB_INIT_FUNCTION (vnet_interface_cli_init);
1074 static clib_error_t *
1075 renumber_interface_command_fn (vlib_main_t * vm,
1076 unformat_input_t * input,
1077 vlib_cli_command_t * cmd)
1080 u32 new_dev_instance;
1081 vnet_main_t *vnm = vnet_get_main ();
1084 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1085 return clib_error_return (0, "unknown hardware interface `%U'",
1086 format_unformat_error, input);
1088 if (!unformat (input, "%d", &new_dev_instance))
1089 return clib_error_return (0, "new dev instance missing");
1091 rv = vnet_interface_name_renumber (hw_if_index, new_dev_instance);
1099 return clib_error_return (0, "vnet_interface_name_renumber returned %d",
1109 VLIB_CLI_COMMAND (renumber_interface_command, static) = {
1110 .path = "renumber interface",
1111 .short_help = "renumber interface <interface> <new-dev-instance>",
1112 .function = renumber_interface_command_fn,
1116 static clib_error_t *
1117 promiscuous_cmd (vlib_main_t * vm,
1118 unformat_input_t * input, vlib_cli_command_t * cmd)
1120 vnet_main_t *vnm = vnet_get_main ();
1122 u32 flags = ETHERNET_INTERFACE_FLAG_ACCEPT_ALL;
1123 ethernet_main_t *em = ðernet_main;
1124 ethernet_interface_t *eif;
1126 if (unformat (input, "on %U",
1127 unformat_vnet_hw_interface, vnm, &hw_if_index))
1129 else if (unformat (input, "off %U",
1130 unformat_ethernet_interface, vnm, &hw_if_index))
1133 return clib_error_return (0, "unknown input `%U'",
1134 format_unformat_error, input);
1136 eif = ethernet_get_interface (em, hw_if_index);
1138 return clib_error_return (0, "not supported");
1140 ethernet_set_flags (vnm, hw_if_index, flags);
1145 VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
1146 .path = "set interface promiscuous",
1147 .short_help = "set interface promiscuous [on|off] <interface>",
1148 .function = promiscuous_cmd,
1152 static clib_error_t *
1153 mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1155 vnet_main_t *vnm = vnet_get_main ();
1156 u32 hw_if_index, sw_if_index, mtu;
1157 ethernet_main_t *em = ðernet_main;
1158 u32 mtus[VNET_N_MTU] = { 0, 0, 0, 0 };
1160 if (unformat (input, "%d %U", &mtu,
1161 unformat_vnet_hw_interface, vnm, &hw_if_index))
1164 * Change physical MTU on interface. Only supported for Ethernet
1167 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1168 ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
1171 return clib_error_return (0, "not supported");
1173 if (mtu < hi->min_supported_packet_bytes)
1174 return clib_error_return (0, "Invalid mtu (%d): "
1175 "must be >= min pkt bytes (%d)", mtu,
1176 hi->min_supported_packet_bytes);
1178 if (mtu > hi->max_supported_packet_bytes)
1179 return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
1180 hi->max_supported_packet_bytes);
1182 vnet_hw_interface_set_mtu (vnm, hw_if_index, mtu);
1185 else if (unformat (input, "packet %d %U", &mtu,
1186 unformat_vnet_sw_interface, vnm, &sw_if_index))
1187 /* Set default packet MTU (including L3 header */
1188 mtus[VNET_MTU_L3] = mtu;
1189 else if (unformat (input, "ip4 %d %U", &mtu,
1190 unformat_vnet_sw_interface, vnm, &sw_if_index))
1191 mtus[VNET_MTU_IP4] = mtu;
1192 else if (unformat (input, "ip6 %d %U", &mtu,
1193 unformat_vnet_sw_interface, vnm, &sw_if_index))
1194 mtus[VNET_MTU_IP6] = mtu;
1195 else if (unformat (input, "mpls %d %U", &mtu,
1196 unformat_vnet_sw_interface, vnm, &sw_if_index))
1197 mtus[VNET_MTU_MPLS] = mtu;
1199 return clib_error_return (0, "unknown input `%U'",
1200 format_unformat_error, input);
1202 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, mtus);
1209 VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
1210 .path = "set interface mtu",
1211 .short_help = "set interface mtu [packet|ip4|ip6|mpls] <value> <interface>",
1212 .function = mtu_cmd,
1216 static clib_error_t *
1217 show_interface_sec_mac_addr_fn (vlib_main_t * vm, unformat_input_t * input,
1218 vlib_cli_command_t * cmd)
1220 vnet_main_t *vnm = vnet_get_main ();
1221 vnet_interface_main_t *im = &vnm->interface_main;
1222 ethernet_main_t *em = ðernet_main;
1223 u32 sw_if_index = ~0;
1224 vnet_sw_interface_t *si, *sorted_sis = 0;
1226 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1228 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
1229 vec_add1 (sorted_sis, si[0]);
1232 /* if an interface name was not passed, get all interfaces */
1233 if (vec_len (sorted_sis) == 0)
1236 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1237 _vec_len (sorted_sis) = 0;
1239 pool_foreach (si, im->sw_interfaces)
1241 int visible = vnet_swif_is_api_visible (si);
1243 vec_add1 (sorted_sis, si[0]);
1247 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
1250 vec_foreach (si, sorted_sis)
1252 vnet_sw_interface_t *sup_si;
1253 ethernet_interface_t *ei;
1255 sup_si = vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1256 ei = ethernet_get_interface (em, sup_si->hw_if_index);
1258 vlib_cli_output (vm, "%U (%s):",
1259 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
1260 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
1263 if (ei && ei->secondary_addrs)
1265 ethernet_interface_address_t *sec_addr;
1267 vec_foreach (sec_addr, ei->secondary_addrs)
1269 vlib_cli_output (vm, " %U", format_mac_address_t, &sec_addr->mac);
1274 vec_free (sorted_sis);
1279 * This command is used to display interface secondary mac addresses.
1282 * Example of how to display interface secondary mac addresses:
1283 * @cliexstart{show interface secondary-mac-address}
1287 VLIB_CLI_COMMAND (show_interface_sec_mac_addr, static) = {
1288 .path = "show interface secondary-mac-address",
1289 .short_help = "show interface secondary-mac-address [<interface>]",
1290 .function = show_interface_sec_mac_addr_fn,
1294 static clib_error_t *
1295 interface_add_del_mac_address (vlib_main_t * vm, unformat_input_t * input,
1296 vlib_cli_command_t * cmd)
1298 vnet_main_t *vnm = vnet_get_main ();
1299 vnet_sw_interface_t *si = NULL;
1300 clib_error_t *error = 0;
1301 u32 sw_if_index = ~0;
1305 is_add = is_del = 0;
1307 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1309 error = clib_error_return (0, "unknown interface `%U'",
1310 format_unformat_error, input);
1313 if (!unformat_user (input, unformat_ethernet_address, mac))
1315 error = clib_error_return (0, "expected mac address `%U'",
1316 format_unformat_error, input);
1320 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1322 if (unformat (input, "add"))
1324 else if (unformat (input, "del"))
1330 if (is_add == is_del)
1332 error = clib_error_return (0, "must choose one of add or del");
1336 si = vnet_get_sw_interface (vnm, sw_if_index);
1338 vnet_hw_interface_add_del_mac_address (vnm, si->hw_if_index, mac, is_add);
1345 * The '<em>set interface secondary-mac-address </em>' command allows adding
1346 * or deleting extra MAC addresses on a given interface without changing the
1347 * default MAC address. This could allow packets sent to these MAC addresses
1348 * to be received without setting the interface to promiscuous mode.
1349 * Not all interfaces support this operation. The ones that do are mostly
1350 * hardware NICs, though virtio does also.
1354 * Example of how to add a secondary MAC Address on an interface:
1355 * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 add}
1356 * Example of how to delete a secondary MAC address from an interface:
1357 * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 del}
1361 VLIB_CLI_COMMAND (interface_add_del_mac_address_cmd, static) = {
1362 .path = "set interface secondary-mac-address",
1363 .short_help = "set interface secondary-mac-address <interface> <mac-address> [(add|del)]",
1364 .function = interface_add_del_mac_address,
1368 static clib_error_t *
1369 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
1370 vlib_cli_command_t * cmd)
1372 vnet_main_t *vnm = vnet_get_main ();
1373 vnet_sw_interface_t *si = NULL;
1374 clib_error_t *error = 0;
1375 u32 sw_if_index = ~0;
1378 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1380 error = clib_error_return (0, "unknown interface `%U'",
1381 format_unformat_error, input);
1384 if (!unformat_user (input, unformat_ethernet_address, mac))
1386 error = clib_error_return (0, "expected mac address `%U'",
1387 format_unformat_error, input);
1390 si = vnet_get_sw_interface (vnm, sw_if_index);
1391 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
1397 * The '<em>set interface mac address </em>' command allows to set MAC address of given interface.
1398 * In case of NIC interfaces the one has to support MAC address change. A side effect of MAC address
1399 * change are changes of MAC addresses in FIB tables (ipv4 and ipv6).
1403 * Example of how to change MAC Address of interface:
1404 * @cliexcmd{set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01}
1405 * @cliexcmd{set interface mac address host-vpp0 aa:bb:cc:dd:ee:02}
1406 * @cliexcmd{set interface mac address tap-0 aa:bb:cc:dd:ee:03}
1407 * @cliexcmd{set interface mac address pg0 aa:bb:cc:dd:ee:04}
1411 VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
1412 .path = "set interface mac address",
1413 .short_help = "set interface mac address <interface> <mac-address>",
1414 .function = set_interface_mac_address,
1418 static clib_error_t *
1419 set_tag (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1421 vnet_main_t *vnm = vnet_get_main ();
1422 u32 sw_if_index = ~0;
1425 if (!unformat (input, "%U %s", unformat_vnet_sw_interface,
1426 vnm, &sw_if_index, &tag))
1427 return clib_error_return (0, "unknown input `%U'",
1428 format_unformat_error, input);
1430 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
1436 VLIB_CLI_COMMAND (set_tag_command, static) = {
1437 .path = "set interface tag",
1438 .short_help = "set interface tag <interface> <tag>",
1439 .function = set_tag,
1443 static clib_error_t *
1444 clear_tag (vlib_main_t * vm, unformat_input_t * input,
1445 vlib_cli_command_t * cmd)
1447 vnet_main_t *vnm = vnet_get_main ();
1448 u32 sw_if_index = ~0;
1450 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1451 return clib_error_return (0, "unknown input `%U'",
1452 format_unformat_error, input);
1454 vnet_clear_sw_interface_tag (vnm, sw_if_index);
1460 VLIB_CLI_COMMAND (clear_tag_command, static) = {
1461 .path = "clear interface tag",
1462 .short_help = "clear interface tag <interface>",
1463 .function = clear_tag,
1467 static clib_error_t *
1468 set_ip_directed_broadcast (vlib_main_t * vm,
1469 unformat_input_t * input, vlib_cli_command_t * cmd)
1471 vnet_main_t *vnm = vnet_get_main ();
1472 u32 sw_if_index = ~0;
1475 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index));
1476 else if (unformat (input, "enable"))
1478 else if (unformat (input, "disable"))
1481 return clib_error_return (0, "unknown input: `%U'",
1482 format_unformat_error, input);
1484 if (~0 == sw_if_index)
1485 return clib_error_return (0, "specify an interface: `%U'",
1486 format_unformat_error, input);
1488 vnet_sw_interface_ip_directed_broadcast (vnm, sw_if_index, enable);
1494 * This command is used to enable/disable IP directed broadcast
1495 * If directed broadcast is enabled a packet sent to the interface's
1496 * subnet broadcast address will be sent L2 broadcast on the interface,
1497 * otherwise it is dropped.
1500 VLIB_CLI_COMMAND (set_ip_directed_broadcast_command, static) = {
1501 .path = "set interface ip directed-broadcast",
1502 .short_help = "set interface enable <interface> <enable|disable>",
1503 .function = set_ip_directed_broadcast,
1508 set_hw_interface_change_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1509 u8 queue_id_valid, u32 queue_id,
1510 vnet_hw_if_rx_mode mode)
1512 clib_error_t *error = 0;
1513 vnet_hw_interface_t *hw;
1514 u32 *queue_indices = 0;
1516 hw = vnet_get_hw_interface (vnm, hw_if_index);
1522 vnet_hw_if_get_rx_queue_index_by_id (vnm, hw_if_index, queue_id);
1523 if (queue_index == ~0)
1524 return clib_error_return (0, "unknown queue %u on interface %s",
1525 queue_id, hw->name);
1526 vec_add1 (queue_indices, queue_index);
1529 queue_indices = hw->rx_queue_indices;
1531 for (int i = 0; i < vec_len (queue_indices); i++)
1533 int rv = vnet_hw_if_set_rx_queue_mode (vnm, queue_indices[i], mode);
1539 if (queue_indices != hw->rx_queue_indices)
1540 vec_free (queue_indices);
1541 vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1545 static clib_error_t *
1546 set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
1547 vlib_cli_command_t * cmd)
1549 clib_error_t *error = 0;
1550 unformat_input_t _line_input, *line_input = &_line_input;
1551 vnet_main_t *vnm = vnet_get_main ();
1552 u32 hw_if_index = (u32) ~ 0;
1553 u32 queue_id = (u32) ~ 0;
1554 vnet_hw_if_rx_mode mode = VNET_HW_IF_RX_MODE_UNKNOWN;
1555 u8 queue_id_valid = 0;
1557 if (!unformat_user (input, unformat_line_input, line_input))
1560 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1563 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1565 else if (unformat (line_input, "queue %d", &queue_id))
1567 else if (unformat (line_input, "polling"))
1568 mode = VNET_HW_IF_RX_MODE_POLLING;
1569 else if (unformat (line_input, "interrupt"))
1570 mode = VNET_HW_IF_RX_MODE_INTERRUPT;
1571 else if (unformat (line_input, "adaptive"))
1572 mode = VNET_HW_IF_RX_MODE_ADAPTIVE;
1575 error = clib_error_return (0, "parse error: '%U'",
1576 format_unformat_error, line_input);
1577 unformat_free (line_input);
1582 unformat_free (line_input);
1584 if (hw_if_index == (u32) ~ 0)
1585 return clib_error_return (0, "please specify valid interface name");
1587 if (mode == VNET_HW_IF_RX_MODE_UNKNOWN)
1588 return clib_error_return (0, "please specify valid rx-mode");
1590 error = set_hw_interface_change_rx_mode (vnm, hw_if_index, queue_id_valid,
1597 * This command is used to assign the RX packet processing mode (polling,
1598 * interrupt, adaptive) of the a given interface, and optionally a
1599 * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
1600 * is applied to all queues of the interface. Not all interfaces support
1601 * all modes. To display the current rx-mode use the command
1602 * '<em>show interface rx-placement</em>'.
1605 * Example of how to assign rx-mode to all queues on an interface:
1606 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
1607 * Example of how to assign rx-mode to one queue of an interface:
1608 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
1609 * Example of how to display the rx-mode of all interfaces:
1610 * @cliexstart{show interface rx-placement}
1611 * Thread 1 (vpp_wk_0):
1613 * GigabitEthernet7/0/0 queue 0 (polling)
1614 * node vhost-user-input:
1615 * VirtualEthernet0/0/12 queue 0 (interrupt)
1616 * VirtualEthernet0/0/12 queue 2 (polling)
1617 * VirtualEthernet0/0/13 queue 0 (polling)
1618 * VirtualEthernet0/0/13 queue 2 (polling)
1619 * Thread 2 (vpp_wk_1):
1621 * GigabitEthernet7/0/1 queue 0 (polling)
1622 * node vhost-user-input:
1623 * VirtualEthernet0/0/12 queue 1 (polling)
1624 * VirtualEthernet0/0/12 queue 3 (polling)
1625 * VirtualEthernet0/0/13 queue 1 (polling)
1626 * VirtualEthernet0/0/13 queue 3 (polling)
1630 VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
1631 .path = "set interface rx-mode",
1632 .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
1633 .function = set_interface_rx_mode,
1637 static clib_error_t *
1638 show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
1639 vlib_cli_command_t * cmd)
1642 vnet_main_t *vnm = vnet_get_main ();
1643 vnet_hw_if_rx_queue_t **all_queues = 0;
1644 vnet_hw_if_rx_queue_t **qptr;
1645 vnet_hw_if_rx_queue_t *q;
1646 pool_foreach (q, vnm->interface_main.hw_if_rx_queues)
1647 vec_add1 (all_queues, q);
1648 vec_sort_with_function (all_queues, vnet_hw_if_rxq_cmp_cli_api);
1651 vec_foreach (qptr, all_queues)
1653 u32 current_thread = qptr[0]->thread_index;
1654 u32 hw_if_index = qptr[0]->hw_if_index;
1655 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1656 u32 current_node = hw_if->input_node_index;
1657 if (current_node != prev_node)
1658 s = format (s, " node %U:\n", format_vlib_node_name, vm, current_node);
1659 s = format (s, " %U queue %u (%U)\n", format_vnet_sw_if_index_name,
1660 vnm, hw_if->sw_if_index, qptr[0]->queue_id,
1661 format_vnet_hw_if_rx_mode, qptr[0]->mode);
1662 if (qptr == all_queues + vec_len (all_queues) - 1 ||
1663 current_thread != qptr[1]->thread_index)
1665 vlib_cli_output (vm, "Thread %u (%s):\n%v", current_thread,
1666 vlib_worker_threads[current_thread].name, s);
1667 vec_reset_length (s);
1669 prev_node = current_node;
1672 vec_free (all_queues);
1677 * This command is used to display the interface and queue worker
1681 * Example of how to display the interface placement:
1682 * @cliexstart{show interface rx-placement}
1683 * Thread 1 (vpp_wk_0):
1685 * GigabitEthernet7/0/0 queue 0 (polling)
1686 * node vhost-user-input:
1687 * VirtualEthernet0/0/12 queue 0 (polling)
1688 * VirtualEthernet0/0/12 queue 2 (polling)
1689 * VirtualEthernet0/0/13 queue 0 (polling)
1690 * VirtualEthernet0/0/13 queue 2 (polling)
1691 * Thread 2 (vpp_wk_1):
1693 * GigabitEthernet7/0/1 queue 0 (polling)
1694 * node vhost-user-input:
1695 * VirtualEthernet0/0/12 queue 1 (polling)
1696 * VirtualEthernet0/0/12 queue 3 (polling)
1697 * VirtualEthernet0/0/13 queue 1 (polling)
1698 * VirtualEthernet0/0/13 queue 3 (polling)
1702 VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
1703 .path = "show interface rx-placement",
1704 .short_help = "show interface rx-placement",
1705 .function = show_interface_rx_placement_fn,
1709 set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
1710 u32 thread_index, u8 is_main)
1712 vnet_main_t *vnm = vnet_get_main ();
1713 vnet_device_main_t *vdm = &vnet_device_main;
1714 vnet_hw_interface_t *hw;
1720 thread_index += vdm->first_worker_thread_index;
1722 if (thread_index > vdm->last_worker_thread_index)
1723 return clib_error_return (0,
1724 "please specify valid worker thread or main");
1726 hw = vnet_get_hw_interface (vnm, hw_if_index);
1729 vnet_hw_if_get_rx_queue_index_by_id (vnm, hw_if_index, queue_id);
1730 if (queue_index == ~0)
1731 return clib_error_return (0, "unknown queue %u on interface %s", queue_id,
1733 vnet_hw_if_set_rx_queue_thread_index (vnm, queue_index, thread_index);
1734 vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1738 static clib_error_t *
1739 set_interface_rx_placement (vlib_main_t *vm, unformat_input_t *input,
1740 vlib_cli_command_t *cmd)
1742 clib_error_t *error = 0;
1743 unformat_input_t _line_input, *line_input = &_line_input;
1744 vnet_main_t *vnm = vnet_get_main ();
1745 u32 hw_if_index = (u32) ~ 0;
1746 u32 queue_id = (u32) 0;
1747 u32 thread_index = (u32) ~ 0;
1750 if (!unformat_user (input, unformat_line_input, line_input))
1753 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1756 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1758 else if (unformat (line_input, "queue %d", &queue_id))
1760 else if (unformat (line_input, "main", &thread_index))
1762 else if (unformat (line_input, "worker %d", &thread_index))
1766 error = clib_error_return (0, "parse error: '%U'",
1767 format_unformat_error, line_input);
1768 unformat_free (line_input);
1773 unformat_free (line_input);
1775 if (hw_if_index == (u32) ~ 0)
1776 return clib_error_return (0, "please specify valid interface name");
1778 error = set_hw_interface_rx_placement (hw_if_index, queue_id, thread_index,
1785 * This command is used to assign a given interface, and optionally a
1786 * given queue, to a different thread. If the '<em>queue</em>' is not provided,
1787 * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
1788 * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
1791 * Example of how to display the interface placement:
1792 * @cliexstart{show interface rx-placement}
1793 * Thread 1 (vpp_wk_0):
1795 * GigabitEthernet7/0/0 queue 0 (polling)
1796 * node vhost-user-input:
1797 * VirtualEthernet0/0/12 queue 0 (polling)
1798 * VirtualEthernet0/0/12 queue 2 (polling)
1799 * VirtualEthernet0/0/13 queue 0 (polling)
1800 * VirtualEthernet0/0/13 queue 2 (polling)
1801 * Thread 2 (vpp_wk_1):
1803 * GigabitEthernet7/0/1 queue 0 (polling)
1804 * node vhost-user-input:
1805 * VirtualEthernet0/0/12 queue 1 (polling)
1806 * VirtualEthernet0/0/12 queue 3 (polling)
1807 * VirtualEthernet0/0/13 queue 1 (polling)
1808 * VirtualEthernet0/0/13 queue 3 (polling)
1810 * Example of how to assign a interface and queue to a worker thread:
1811 * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
1812 * Example of how to display the interface placement:
1813 * @cliexstart{show interface rx-placement}
1814 * Thread 1 (vpp_wk_0):
1816 * GigabitEthernet7/0/0 queue 0 (polling)
1817 * node vhost-user-input:
1818 * VirtualEthernet0/0/12 queue 0 (polling)
1819 * VirtualEthernet0/0/12 queue 1 (polling)
1820 * VirtualEthernet0/0/12 queue 2 (polling)
1821 * VirtualEthernet0/0/13 queue 0 (polling)
1822 * VirtualEthernet0/0/13 queue 2 (polling)
1823 * Thread 2 (vpp_wk_1):
1825 * GigabitEthernet7/0/1 queue 0 (polling)
1826 * node vhost-user-input:
1827 * VirtualEthernet0/0/12 queue 3 (polling)
1828 * VirtualEthernet0/0/13 queue 1 (polling)
1829 * VirtualEthernet0/0/13 queue 3 (polling)
1833 VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
1834 .path = "set interface rx-placement",
1835 .short_help = "set interface rx-placement <interface> [queue <n>] "
1836 "[worker <n> | main]",
1837 .function = set_interface_rx_placement,
1843 set_hw_interface_tx_queue (u32 hw_if_index, u32 queue_id, uword *bitmap)
1845 vnet_main_t *vnm = vnet_get_main ();
1846 vnet_device_main_t *vdm = &vnet_device_main;
1847 vnet_hw_interface_t *hw;
1848 vnet_hw_if_tx_queue_t *txq;
1852 hw = vnet_get_hw_interface (vnm, hw_if_index);
1854 /* highest set bit in bitmap should not exceed last worker thread index */
1855 thread_index = clib_bitmap_last_set (bitmap);
1856 if ((thread_index != ~0) && (thread_index > vdm->last_worker_thread_index))
1857 return clib_error_return (0, "please specify valid thread(s)");
1860 vnet_hw_if_get_tx_queue_index_by_id (vnm, hw_if_index, queue_id);
1861 if (queue_index == ~0)
1862 return clib_error_return (0, "unknown queue %u on interface %s", queue_id,
1865 txq = vnet_hw_if_get_tx_queue (vnm, queue_index);
1867 // free the existing bitmap
1868 if (clib_bitmap_count_set_bits (txq->threads))
1870 txq->shared_queue = 0;
1871 clib_bitmap_free (txq->threads);
1874 clib_bitmap_foreach (thread_index, bitmap)
1875 vnet_hw_if_tx_queue_assign_thread (vnm, queue_index, thread_index);
1877 vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1881 static clib_error_t *
1882 set_interface_tx_queue (vlib_main_t *vm, unformat_input_t *input,
1883 vlib_cli_command_t *cmd)
1885 clib_error_t *error = 0;
1886 unformat_input_t _line_input, *line_input = &_line_input;
1887 vnet_main_t *vnm = vnet_get_main ();
1888 u32 hw_if_index = (u32) ~0;
1889 u32 queue_id = (u32) 0;
1892 if (!unformat_user (input, unformat_line_input, line_input))
1895 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1897 if (unformat (line_input, "%U", unformat_vnet_hw_interface, vnm,
1900 else if (unformat (line_input, "queue %d", &queue_id))
1902 else if (unformat (line_input, "threads %U", unformat_bitmap_list,
1907 error = clib_error_return (0, "parse error: '%U'",
1908 format_unformat_error, line_input);
1909 unformat_free (line_input);
1914 unformat_free (line_input);
1916 if (hw_if_index == (u32) ~0)
1918 error = clib_error_return (0, "please specify valid interface name");
1922 error = set_hw_interface_tx_queue (hw_if_index, queue_id, bitmap);
1925 clib_bitmap_free (bitmap);
1929 VLIB_CLI_COMMAND (cmd_set_if_tx_queue, static) = {
1930 .path = "set interface tx-queue",
1931 .short_help = "set interface tx-queue <interface> queue <n> "
1933 .function = set_interface_tx_queue,
1938 set_interface_rss_queues (vlib_main_t * vm, u32 hw_if_index,
1939 clib_bitmap_t * bitmap)
1941 vnet_main_t *vnm = vnet_get_main ();
1942 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1944 return vnet_hw_interface_set_rss_queues (vnm, hi, bitmap);
1947 static clib_error_t *
1948 set_interface_rss_queues_fn (vlib_main_t * vm,
1949 unformat_input_t * input,
1950 vlib_cli_command_t * cmd)
1952 clib_error_t *error = 0;
1953 unformat_input_t _line_input, *line_input = &_line_input;
1954 vnet_main_t *vnm = vnet_get_main ();
1955 u32 hw_if_index = (u32) ~ 0;
1956 clib_bitmap_t *bitmap = NULL;
1958 if (!unformat_user (input, unformat_line_input, line_input))
1961 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1964 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1967 if (unformat (line_input, "list %U", unformat_bitmap_list, &bitmap))
1971 error = clib_error_return (0, "parse error: '%U'",
1972 format_unformat_error, line_input);
1973 unformat_free (line_input);
1978 unformat_free (line_input);
1980 if (hw_if_index == (u32) ~ 0)
1982 error = clib_error_return (0, "please specify valid interface name");
1988 error = clib_error_return (0, "please specify the valid rss queues");
1992 error = set_interface_rss_queues (vm, hw_if_index, bitmap);
1996 clib_bitmap_free (bitmap);
2002 * This command is used to set the rss queues of a given interface
2003 * Not all the interfaces support this operation.
2004 * To display the current rss queues, use the command
2005 * '<em>show hardware-interfaces</em>'.
2008 * Example of how to set the rss queues to 0,2-5,7 of an interface:
2009 * @cliexstart{set interface rss queues VirtualFunctionEthernet18/1/0 list 0,2-5,7}
2013 VLIB_CLI_COMMAND (cmd_set_interface_rss_queues,static) = {
2014 .path = "set interface rss queues",
2015 .short_help = "set interface rss queues <interface> <list <queue-list>>",
2016 .function = set_interface_rss_queues_fn,
2021 format_vnet_pcap (u8 * s, va_list * args)
2023 vnet_pcap_t *pp = va_arg (*args, vnet_pcap_t *);
2024 int type = va_arg (*args, int);
2029 if (pp->pcap_rx_enable)
2031 s = format (s, "rx");
2034 if (pp->pcap_tx_enable)
2037 s = format (s, " and ");
2038 s = format (s, "tx");
2041 if (pp->pcap_drop_enable)
2044 s = format (s, " and ");
2045 s = format (s, "drop");
2050 s = format (s, "unknown type %d!", type);
2056 vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
2058 vlib_main_t *vm = vlib_get_main ();
2059 vnet_main_t *vnm = vnet_get_main ();
2060 vnet_pcap_t *pp = &vnm->pcap;
2061 pcap_main_t *pm = &pp->pcap_main;
2062 vnet_classify_main_t *cm = &vnet_classify_main;
2066 if (pp->pcap_rx_enable || pp->pcap_tx_enable || pp->pcap_drop_enable)
2069 (vm, "pcap %U dispatch capture enabled: %d of %d pkts...",
2070 format_vnet_pcap, pp, 0 /* print type */ ,
2071 pm->n_packets_captured, pm->n_packets_to_capture);
2072 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2075 vlib_cli_output (vm, "pcap dispatch capture disabled");
2080 /* Consistency checks */
2082 /* Enable w/ capture already enabled not allowed */
2083 if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
2084 && (a->rx_enable + a->tx_enable + a->drop_enable))
2085 return VNET_API_ERROR_INVALID_VALUE;
2087 /* Disable capture with capture already disabled, not interesting */
2088 if (((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable) ==
2090 ((a->rx_enable + a->tx_enable + a->drop_enable == 0)))
2091 return VNET_API_ERROR_VALUE_EXIST;
2093 /* Change number of packets to capture while capturing */
2094 if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
2095 && (a->rx_enable + a->tx_enable + a->drop_enable)
2096 && (pm->n_packets_to_capture != a->packets_to_capture))
2097 return VNET_API_ERROR_INVALID_VALUE_2;
2099 /* Classify filter specified, but no classify filter configured */
2100 if ((a->rx_enable + a->tx_enable + a->drop_enable) && a->filter &&
2101 (!cm->classify_table_index_by_sw_if_index ||
2102 cm->classify_table_index_by_sw_if_index[0] == ~0))
2103 return VNET_API_ERROR_NO_SUCH_LABEL;
2105 if (a->rx_enable + a->tx_enable + a->drop_enable)
2107 void *save_pcap_data;
2109 /* Sanity check max bytes per pkt */
2110 if (a->max_bytes_per_pkt < 32 || a->max_bytes_per_pkt > 9000)
2111 return VNET_API_ERROR_INVALID_MEMORY_SIZE;
2113 /* Clean up from previous run, if any */
2114 vec_reset_length (pm->pcap_data);
2116 /* Throw away the data buffer? */
2118 vec_free (pm->pcap_data);
2120 save_pcap_data = pm->pcap_data;
2122 memset (pm, 0, sizeof (*pm));
2124 pm->pcap_data = save_pcap_data;
2126 vec_validate_aligned (vnet_trace_placeholder, 2048,
2127 CLIB_CACHE_LINE_BYTES);
2129 clib_spinlock_init (&(pm->lock));
2131 if (a->filename == 0)
2136 stem = format (stem, "rx");
2138 stem = format (stem, "tx");
2140 stem = format (stem, "drop");
2141 a->filename = format (0, "/tmp/%v.pcap%c", stem, 0);
2145 pm->file_name = (char *) a->filename;
2146 pm->n_packets_captured = 0;
2147 pm->packet_type = PCAP_PACKET_TYPE_ethernet;
2148 /* Preallocate the data vector? */
2149 if (a->preallocate_data)
2152 (pm->pcap_data, a->packets_to_capture
2153 * ((sizeof (pcap_packet_header_t) + a->max_bytes_per_pkt)));
2154 vec_reset_length (pm->pcap_data);
2156 pm->n_packets_to_capture = a->packets_to_capture;
2157 pp->pcap_sw_if_index = a->sw_if_index;
2159 pp->filter_classify_table_index =
2160 cm->classify_table_index_by_sw_if_index[0];
2162 pp->filter_classify_table_index = ~0;
2163 pp->pcap_error_index = a->drop_err;
2164 pp->pcap_rx_enable = a->rx_enable;
2165 pp->pcap_tx_enable = a->tx_enable;
2166 pp->pcap_drop_enable = a->drop_enable;
2167 pp->max_bytes_per_pkt = a->max_bytes_per_pkt;
2171 pp->pcap_rx_enable = 0;
2172 pp->pcap_tx_enable = 0;
2173 pp->pcap_drop_enable = 0;
2174 pp->filter_classify_table_index = ~0;
2175 pp->pcap_error_index = ~0;
2176 if (pm->n_packets_captured)
2178 clib_error_t *error;
2179 pm->n_packets_to_capture = pm->n_packets_captured;
2180 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2181 pm->n_packets_captured, pm->file_name);
2182 error = pcap_write (pm);
2183 if (pm->flags & PCAP_MAIN_INIT_DONE)
2185 /* Report I/O errors... */
2188 clib_error_report (error);
2189 return VNET_API_ERROR_SYSCALL_ERROR_1;
2191 vec_free (pm->file_name);
2193 vec_free (pm->pcap_data);
2197 return VNET_API_ERROR_NO_SUCH_ENTRY;
2203 static clib_error_t *
2204 pcap_trace_command_fn (vlib_main_t * vm,
2205 unformat_input_t * input, vlib_cli_command_t * cmd)
2207 unformat_input_t _line_input, *line_input = &_line_input;
2208 vnet_pcap_dispatch_trace_args_t _a, *a = &_a;
2209 vnet_main_t *vnm = vnet_get_main ();
2212 u32 max_bytes_per_pkt = 512;
2216 int preallocate_data = 0;
2217 int drop_enable = 0;
2221 u32 sw_if_index = 0; /* default: any interface */
2222 vlib_error_t drop_err = ~0; /* default: any error */
2224 /* Get a line of input. */
2225 if (!unformat_user (input, unformat_line_input, line_input))
2228 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2230 if (unformat (line_input, "rx"))
2232 else if (unformat (line_input, "tx"))
2234 else if (unformat (line_input, "drop"))
2236 else if (unformat (line_input, "off"))
2237 rx_enable = tx_enable = drop_enable = 0;
2238 else if (unformat (line_input, "max-bytes-per-pkt %u",
2239 &max_bytes_per_pkt))
2241 else if (unformat (line_input, "max %d", &max))
2243 else if (unformat (line_input, "packets-to-capture %d", &max))
2245 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2248 else if (unformat (line_input, "status %=", &status, 1))
2250 else if (unformat (line_input, "intfc %U",
2251 unformat_vnet_sw_interface, vnm, &sw_if_index))
2253 else if (unformat (line_input, "interface %U",
2254 unformat_vnet_sw_interface, vnm, &sw_if_index))
2256 else if (unformat (line_input, "error %U", unformat_vlib_error, vm,
2259 else if (unformat (line_input, "preallocate-data %=",
2260 &preallocate_data, 1))
2262 else if (unformat (line_input, "free-data %=", &free_data, 1))
2264 else if (unformat (line_input, "intfc any")
2265 || unformat (line_input, "interface any"))
2267 else if (unformat (line_input, "filter"))
2271 return clib_error_return (0, "unknown input `%U'",
2272 format_unformat_error, line_input);
2276 unformat_free (line_input);
2278 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2279 a->filename = filename;
2280 a->rx_enable = rx_enable;
2281 a->tx_enable = tx_enable;
2282 a->preallocate_data = preallocate_data;
2283 a->free_data = free_data;
2284 a->drop_enable = drop_enable;
2286 a->packets_to_capture = max;
2287 a->sw_if_index = sw_if_index;
2289 a->max_bytes_per_pkt = max_bytes_per_pkt;
2290 a->drop_err = drop_err;
2292 rv = vnet_pcap_dispatch_trace_configure (a);
2299 case VNET_API_ERROR_INVALID_VALUE:
2300 return clib_error_return (0, "dispatch trace already enabled...");
2302 case VNET_API_ERROR_VALUE_EXIST:
2303 return clib_error_return (0, "dispatch trace already disabled...");
2305 case VNET_API_ERROR_INVALID_VALUE_2:
2306 return clib_error_return
2307 (0, "can't change number of records to capture while tracing...");
2309 case VNET_API_ERROR_SYSCALL_ERROR_1:
2310 return clib_error_return (0, "I/O writing trace capture...");
2312 case VNET_API_ERROR_NO_SUCH_ENTRY:
2313 return clib_error_return (0, "No packets captured...");
2315 case VNET_API_ERROR_INVALID_MEMORY_SIZE:
2316 return clib_error_return (0,
2317 "Max bytes per pkt must be > 32, < 9000...");
2319 case VNET_API_ERROR_NO_SUCH_LABEL:
2320 return clib_error_return
2321 (0, "No classify filter configured, see 'classify filter...'");
2324 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2331 * This command is used to start or stop a packet capture, or show
2332 * the status of packet capture.
2334 * This command has the following optional parameters:
2337 * - <b>rx</b> - Capture received packets
2339 * - <b>tx</b> - Capture transmitted packets
2341 * - <b>drop</b> - Capture dropped packets
2343 * - <b>off</b> - Stop capturing packets, write results to the specified file
2345 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2346 * of packets have been received, buffer is flushed to file. Once another
2347 * '<em>nn</em>' number of packets have been received, buffer is flushed
2348 * to file, overwriting previous write. If not entered, value defaults
2349 * to 100. Can only be updated if packet capture is off.
2351 * - <b>max-bytes-per-pkt <nnnn></b> - Maximum number of bytes to capture
2352 * for each packet. Must be >= 32, <= 9000.
2354 * - <b>preallocate-data</b> - Preallocate the data buffer, to avoid
2355 * vector expansion delays during pcap capture
2357 * - <b>free-data</b> - Free the data buffer. Ordinarily it's a feature
2358 * to retain the data buffer so this option is seldom used.
2360 * - <b>intfc <interface-name>|any</b> - Used to specify a given interface,
2361 * or use '<em>any</em>' to run packet capture on all interfaces.
2362 * '<em>any</em>' is the default if not provided. Settings from a previous
2363 * packet capture are preserved, so '<em>any</em>' can be used to reset
2364 * the interface setting.
2366 * - <b>filter</b> - Use the pcap rx / tx / drop trace filter, which
2367 * must be configured. Use <b>classify filter pcap...</b> to configure the
2368 * filter. The filter will only be executed if the per-interface or
2369 * any-interface tests fail.
2371 * - <b>error <node>.<error></b> - filter packets based on a specific error.
2372 * For example: error {ip4-udp-lookup}.{No listener for dst port}
2374 * - <b>file <name></b> - Used to specify the output filename. The file will
2375 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2376 * supported. Directory should not be entered. If file already exists, file
2377 * will be overwritten. If no filename is provided, the file will be
2378 * named "/tmp/rx.pcap", "/tmp/tx.pcap", "/tmp/rxandtx.pcap", etc.
2379 * Can only be updated if packet capture is off.
2381 * - <b>status</b> - Displays the current status and configured attributes
2382 * associated with a packet capture. If packet capture is in progress,
2383 * '<em>status</em>' also will return the number of packets currently in
2384 * the local buffer. All additional attributes entered on command line
2385 * with '<em>status</em>' will be ignored and not applied.
2388 * Example of how to display the status of a tx packet capture when off:
2389 * @cliexstart{pcap trace status}
2390 * max is 100, for any interface to file /tmp/vpe.pcap
2391 * pcap tx capture is off...
2393 * Example of how to start a tx packet capture:
2394 * @cliexstart{pcap trace tx max 35 intfc GigabitEthernet0/8/0 file
2397 * Example of how to display the status of a tx packet capture in progress:
2398 * @cliexstart{pcap trace status}
2399 * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
2400 * pcap tx capture is on: 20 of 35 pkts...
2402 * Example of how to stop a tx packet capture:
2403 * @cliexstart{pcap trace off}
2404 * captured 21 pkts...
2405 * saved to /tmp/vppTest.pcap...
2410 VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
2411 .path = "pcap trace",
2413 "pcap trace [rx] [tx] [drop] [off] [max <nn>] [intfc <interface>|any]\n"
2414 " [file <name>] [status] [max-bytes-per-pkt <nnnn>][filter]\n"
2415 " [preallocate-data][free-data]",
2416 .function = pcap_trace_command_fn,
2420 static clib_error_t *
2421 set_interface_name (vlib_main_t *vm, unformat_input_t *input,
2422 vlib_cli_command_t *cmd)
2424 clib_error_t *error = 0;
2425 unformat_input_t _line_input, *line_input = &_line_input;
2426 vnet_main_t *vnm = vnet_get_main ();
2427 u32 hw_if_index = ~0;
2430 if (!unformat_user (input, unformat_line_input, line_input))
2433 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2435 if (unformat (line_input, "%U %s", unformat_vnet_hw_interface, vnm,
2436 &hw_if_index, &name))
2440 error = clib_error_return (0, "parse error: '%U'",
2441 format_unformat_error, line_input);
2442 unformat_free (line_input);
2448 unformat_free (line_input);
2450 if (hw_if_index == (u32) ~0 || name == 0)
2453 error = clib_error_return (0, "please specify valid interface name");
2457 error = vnet_rename_interface (vnm, hw_if_index, name);
2463 VLIB_CLI_COMMAND (cmd_set_if_name, static) = {
2464 .path = "set interface name",
2465 .short_help = "set interface name <interface-name> <new-interface-name>",
2466 .function = set_interface_name,
2470 * fd.io coding-style-patch-verification: ON
2473 * eval: (c-set-style "gnu")