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>
56 #include <vnet/hash/hash.h>
58 compare_interface_names (void *a1, void *a2)
63 return vnet_hw_interface_compare (vnet_get_main (), *hi1, *hi2);
67 show_or_clear_hw_interfaces (vlib_main_t * vm,
68 unformat_input_t * input,
69 vlib_cli_command_t * cmd, int is_show)
71 clib_error_t *error = 0;
72 vnet_main_t *vnm = vnet_get_main ();
73 vnet_interface_main_t *im = &vnm->interface_main;
74 vnet_hw_interface_t *hi;
75 u32 hw_if_index, *hw_if_indices = 0;
76 int i, verbose = -1, show_bond = 0;
78 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
80 /* See if user wants to show a specific interface. */
82 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
83 vec_add1 (hw_if_indices, hw_if_index);
85 /* See if user wants to show an interface with a specific hw_if_index. */
86 else if (unformat (input, "%u", &hw_if_index))
87 vec_add1 (hw_if_indices, hw_if_index);
89 else if (unformat (input, "verbose"))
90 verbose = 1; /* this is also the default */
92 else if (unformat (input, "detail"))
95 else if (unformat (input, "brief"))
98 else if (unformat (input, "bond"))
102 verbose = 0; /* default to brief for link bonding */
107 error = clib_error_return (0, "unknown input `%U'",
108 format_unformat_error, input);
113 /* Gather interfaces. */
114 if (vec_len (hw_if_indices) == 0)
115 pool_foreach (hi, im->hw_interfaces)
116 vec_add1 (hw_if_indices, hi - im->hw_interfaces);
119 verbose = 1; /* default to verbose (except bond) */
124 vec_sort_with_function (hw_if_indices, compare_interface_names);
126 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm, 0, verbose);
127 for (i = 0; i < vec_len (hw_if_indices); i++)
129 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
130 if (show_bond == 0) /* show all interfaces */
131 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
133 else if ((hi->bond_info) &&
134 (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
135 { /* show only bonded interface and all its slave interfaces */
137 vnet_hw_interface_t *shi;
138 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
142 clib_bitmap_foreach (hw_idx, hi->bond_info)
144 shi = vnet_get_hw_interface(vnm, hw_idx);
145 vlib_cli_output (vm, "%U\n",
146 format_vnet_hw_interface, vnm, shi, verbose);
154 for (i = 0; i < vec_len (hw_if_indices); i++)
156 vnet_device_class_t *dc;
158 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
159 dc = vec_elt_at_index (im->device_classes, hi->dev_class_index);
161 if (dc->clear_counters)
162 dc->clear_counters (hi->dev_instance);
167 vec_free (hw_if_indices);
171 static clib_error_t *
172 show_hw_interfaces (vlib_main_t * vm,
173 unformat_input_t * input, vlib_cli_command_t * cmd)
175 return show_or_clear_hw_interfaces (vm, input, cmd, 1 /* is_show */ );
178 static clib_error_t *
179 clear_hw_interfaces (vlib_main_t * vm,
180 unformat_input_t * input, vlib_cli_command_t * cmd)
182 return show_or_clear_hw_interfaces (vm, input, cmd, 0 /* is_show */ );
187 * Display more detailed information about all or a list of given interfaces.
188 * The verboseness of the output can be controlled by the following optional
190 * - brief: Only show name, index and state (default for bonded interfaces).
191 * - verbose: Also display additional attributes (default for all other interfaces).
192 * - detail: Also display all remaining attributes and extended statistics.
194 * To limit the output of the command to bonded interfaces and their slave
195 * interfaces, use the '<em>bond</em>' optional parameter.
198 * Example of how to display default data for all interfaces:
199 * @cliexstart{show hardware-interfaces}
200 * Name Idx Link Hardware
201 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
202 * Ethernet address ec:f4:bb:c0:bc:fc
204 * carrier up full duplex speed 1000 mtu 9216
205 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
207 * GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
208 * Ethernet address ec:f4:bb:c0:bc:fd
210 * carrier up full duplex speed 1000 mtu 9216
211 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
213 * VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
214 * Ethernet address 02:fe:a5:a9:8b:8e
215 * VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
216 * Ethernet address 02:fe:c0:4e:3b:b0
217 * VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
218 * Ethernet address 02:fe:1f:73:92:81
219 * VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
220 * Ethernet address 02:fe:f2:25:c4:68
221 * local0 0 down local0
224 * Example of how to display '<em>verbose</em>' data for an interface by name and
225 * software index (where 2 is the software index):
226 * @cliexstart{show hardware-interfaces GigabitEthernet7/0/0 2 verbose}
227 * Name Idx Link Hardware
228 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
229 * Ethernet address ec:f4:bb:c0:bc:fc
231 * carrier up full duplex speed 1000 mtu 9216
232 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
234 * GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
235 * Ethernet address ec:f4:bb:c0:bc:fd
237 * carrier up full duplex speed 1000 mtu 9216
238 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
243 VLIB_CLI_COMMAND (show_hw_interfaces_command, static) = {
244 .path = "show hardware-interfaces",
245 .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] "
246 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
247 .function = show_hw_interfaces,
253 * Clear the extended statistics for all or a list of given interfaces
254 * (statistics associated with the '<em>show hardware-interfaces</em>' command).
257 * Example of how to clear the extended statistics for all interfaces:
258 * @cliexcmd{clear hardware-interfaces}
259 * Example of how to clear the extended statistics for an interface by
260 * name and software index (where 2 is the software index):
261 * @cliexcmd{clear hardware-interfaces GigabitEthernet7/0/0 2}
264 VLIB_CLI_COMMAND (clear_hw_interface_counters_command, static) = {
265 .path = "clear hardware-interfaces",
266 .short_help = "clear hardware-interfaces "
267 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
268 .function = clear_hw_interfaces,
273 sw_interface_name_compare (void *a1, void *a2)
275 vnet_sw_interface_t *si1 = a1;
276 vnet_sw_interface_t *si2 = a2;
278 return vnet_sw_interface_compare (vnet_get_main (),
279 si1->sw_if_index, si2->sw_if_index);
282 static clib_error_t *
283 show_sw_interfaces (vlib_main_t * vm,
284 unformat_input_t * input, vlib_cli_command_t * cmd)
286 clib_error_t *error = 0;
287 vnet_main_t *vnm = vnet_get_main ();
288 unformat_input_t _linput, *linput = &_linput;
289 vnet_interface_main_t *im = &vnm->interface_main;
290 vnet_sw_interface_t *si, *sorted_sis = 0;
291 u32 sw_if_index = ~(u32) 0;
292 u8 show_addresses = 0;
293 u8 show_features = 0;
299 * Get a line of input. Won't work if the user typed
300 * "show interface" and nothing more.
302 if (unformat_user (input, unformat_line_input, linput))
304 while (unformat_check_input (linput) != UNFORMAT_END_OF_INPUT)
306 /* See if user wants to show specific interface */
308 (linput, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
310 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
311 vec_add1 (sorted_sis, si[0]);
313 else if (unformat (linput, "address") || unformat (linput, "addr"))
315 else if (unformat (linput, "features") || unformat (linput, "feat"))
317 else if (unformat (linput, "tag"))
319 else if (unformat (linput, "vtr"))
321 else if (unformat (linput, "verbose"))
323 else if (unformat (linput, "%d", &sw_if_index))
325 if (!pool_is_free_index (im->sw_interfaces, sw_if_index))
327 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
328 vec_add1 (sorted_sis, si[0]);
332 vec_free (sorted_sis);
333 error = clib_error_return (0, "unknown interface index `%d'",
340 vec_free (sorted_sis);
341 error = clib_error_return (0, "unknown input `%U'",
342 format_unformat_error, linput);
346 unformat_free (linput);
348 if (show_features || show_tag || show_vtr)
350 if (sw_if_index == ~(u32) 0)
352 vec_free (sorted_sis);
353 return clib_error_return (0, "Interface not specified...");
359 vnet_interface_features_show (vm, sw_if_index, verbose);
360 vlib_cli_output (vm, "%U", format_l2_input_features, sw_if_index, 1);
362 l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
363 vlib_cli_output (vm, "\nl2-output:");
364 if (l2_output->out_vtr_flag)
365 vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
366 vlib_cli_output (vm, "%U", format_l2_output_features,
367 l2_output->feature_bitmap, 1);
368 vec_free (sorted_sis);
374 tag = vnet_get_sw_interface_tag (vnm, sw_if_index);
375 vlib_cli_output (vm, "%U: %s",
376 format_vnet_sw_if_index_name, vnm, sw_if_index,
377 tag ? (char *) tag : "(none)");
378 vec_free (sorted_sis);
383 * Show vlan tag rewrite data for one interface.
387 u32 vtr_op = L2_VTR_DISABLED;
388 u32 push_dot1q = 0, tag1 = 0, tag2 = 0;
390 if (l2vtr_get (vm, vnm, sw_if_index,
391 &vtr_op, &push_dot1q, &tag1, &tag2) != 0)
393 vlib_cli_output (vm, "%U: Problem getting vlan tag-rewrite data",
394 format_vnet_sw_if_index_name, vnm, sw_if_index);
397 vlib_cli_output (vm, "%U: VTR %0U",
398 format_vnet_sw_if_index_name, vnm, sw_if_index,
399 format_vtr, vtr_op, push_dot1q, tag1, tag2);
404 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, 0);
406 if (vec_len (sorted_sis) == 0) /* Get all interfaces */
408 /* Gather interfaces. */
410 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
411 _vec_len (sorted_sis) = 0;
413 pool_foreach (si, im->sw_interfaces)
415 int visible = vnet_swif_is_api_visible (si);
417 vec_add1 (sorted_sis, si[0]);
421 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
426 vec_foreach (si, sorted_sis)
428 ip4_main_t *im4 = &ip4_main;
429 ip6_main_t *im6 = &ip6_main;
430 ip_lookup_main_t *lm4 = &im4->lookup_main;
431 ip_lookup_main_t *lm6 = &im6->lookup_main;
432 ip_interface_address_t *ia = 0;
433 u32 fib_index4 = 0, fib_index6 = 0;
435 if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
436 fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
439 if (vec_len (im6->fib_index_by_sw_if_index) > si->sw_if_index)
440 fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
443 ip4_fib_t *fib4 = ip4_fib_get (fib_index4);
444 ip6_fib_t *fib6 = ip6_fib_get (fib_index6);
446 if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
448 (vm, "%U (%s): \n unnumbered, use %U",
449 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
450 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
451 format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
455 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
456 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn");
458 /* Display any L2 info */
459 vlib_cli_output (vm, "%U", format_l2_input, si->sw_if_index);
462 /* Display any IP4 addressing info */
463 foreach_ip_interface_address (lm4, ia, si->sw_if_index,
464 1 /* honor unnumbered */,
466 ip4_address_t *r4 = ip_interface_address_get_address (lm4, ia);
467 if (fib4->hash.table_id)
469 vm, " L3 %U/%d ip4 table-id %d fib-idx %d", format_ip4_address,
470 r4, ia->address_length, fib4->hash.table_id,
471 ip4_fib_index_from_table_id (fib4->hash.table_id));
473 vlib_cli_output (vm, " L3 %U/%d",
474 format_ip4_address, r4, ia->address_length);
479 /* Display any IP6 addressing info */
480 foreach_ip_interface_address (lm6, ia, si->sw_if_index,
481 1 /* honor unnumbered */,
483 ip6_address_t *r6 = ip_interface_address_get_address (lm6, ia);
485 vlib_cli_output (vm, " L3 %U/%d ip6 table-id %d fib-idx %d",
486 format_ip6_address, r6, ia->address_length,
488 ip6_fib_index_from_table_id (fib6->table_id));
490 vlib_cli_output (vm, " L3 %U/%d",
491 format_ip6_address, r6, ia->address_length);
498 vec_foreach (si, sorted_sis)
500 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, si);
505 vec_free (sorted_sis);
510 VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
511 .path = "show interface",
512 .short_help = "show interface [address|addr|features|feat|vtr] [<interface> [<interface> [..]]] [verbose]",
513 .function = show_sw_interfaces,
518 /* Root of all interface commands. */
520 VLIB_CLI_COMMAND (vnet_cli_interface_command, static) = {
522 .short_help = "Interface commands",
527 VLIB_CLI_COMMAND (vnet_cli_set_interface_command, static) = {
528 .path = "set interface",
529 .short_help = "Interface commands",
533 static clib_error_t *
534 clear_interface_counters (vlib_main_t * vm,
535 unformat_input_t * input, vlib_cli_command_t * cmd)
537 vnet_main_t *vnm = vnet_get_main ();
538 vnet_interface_main_t *im = &vnm->interface_main;
539 vlib_simple_counter_main_t *sm;
540 vlib_combined_counter_main_t *cm;
543 n_counters = vec_len (im->combined_sw_if_counters);
545 for (j = 0; j < n_counters; j++)
547 im = &vnm->interface_main;
548 cm = im->combined_sw_if_counters + j;
549 vlib_clear_combined_counters (cm);
552 n_counters = vec_len (im->sw_if_counters);
554 for (j = 0; j < n_counters; j++)
556 im = &vnm->interface_main;
557 sm = im->sw_if_counters + j;
558 vlib_clear_simple_counters (sm);
565 * Clear the statistics for all interfaces (statistics associated with the
566 * '<em>show interface</em>' command).
569 * Example of how to clear the statistics for all interfaces:
570 * @cliexcmd{clear interfaces}
573 VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
574 .path = "clear interfaces",
575 .short_help = "clear interfaces",
576 .function = clear_interface_counters,
581 * Parse subinterface names.
583 * The following subinterface syntax is supported. The first two are for
584 * backwards compatability:
587 * - a subinterface with the name <intf-name>.<id>. The subinterface
588 * is a single dot1q vlan with vlan id <id> and exact-match semantics.
590 * <intf-name> <min_id>-<max_id>
591 * - a set of the above subinterfaces, repeating for each id
592 * in the range <min_id> to <max_id>
594 * In the following, exact-match semantics (i.e. the number of vlan tags on the
595 * packet must match the number of tags in the configuration) are used only if
596 * the keyword exact-match is present. Non-exact match is the default.
598 * <intf-name> <id> dot1q <outer_id> [exact-match]
599 * - a subinterface with the name <intf-name>.<id>. The subinterface
600 * is a single dot1q vlan with vlan id <outer_id>.
602 * <intf-name> <id> dot1q any [exact-match]
603 * - a subinterface with the name <intf-name>.<id>. The subinterface
604 * is a single dot1q vlan with any vlan id.
606 * <intf-name> <id> dot1q <outer_id> inner-dot1q <inner_id> [exact-match]
607 * - a subinterface with the name <intf-name>.<id>. The subinterface
608 * is a double dot1q vlan with outer vlan id <outer_id> and inner vlan id
611 * <intf-name> <id> dot1q <outer_id> inner-dot1q any [exact-match]
612 * - a subinterface with the name <intf-name>.<id>. The subinterface
613 * is a double dot1q vlan with outer vlan id <id> and any inner vlan id.
615 * <intf-name> <id> dot1q any inner-dot1q any [exact-match]
617 * - a subinterface with the name <intf-name>.<id>. The subinterface
618 * is a double dot1q vlan with any outer vlan id and any inner vlan id.
620 * For each of the above CLI, there is a duplicate that uses the keyword
621 * "dot1ad" in place of the first "dot1q". These interfaces use ethertype
622 * 0x88ad in place of 0x8100 for the outer ethertype. Note that for double-
623 * tagged packets the inner ethertype is always 0x8100. Also note that
624 * the dot1q and dot1ad naming spaces are independent, so it is legal to
625 * have both "Gig3/0/0.1 dot1q 100" and "Gig3/0/0.2 dot1ad 100". For example:
627 * <intf-name> <id> dot1ad <outer_id> inner-dot1q <inner_id> [exact-match]
628 * - a subinterface with the name <intf-name>.<id>. The subinterface
629 * is a double dot1ad vlan with outer vlan id <outer_id> and inner vlan
632 * <intf-name> <id> untagged
633 * - a subinterface with the name <intf-name>.<id>. The subinterface
634 * has no vlan tags. Only one can be specified per interface.
636 * <intf-name> <id> default
637 * - a subinterface with the name <intf-name>.<id>. This is associated
638 * with a packet that did not match any other configured subinterface
639 * on this interface. Only one can be specified per interface.
642 static clib_error_t *
643 parse_vlan_sub_interfaces (unformat_input_t * input,
644 vnet_sw_interface_t * template)
646 clib_error_t *error = 0;
647 u32 inner_vlan, outer_vlan;
649 if (unformat (input, "any inner-dot1q any"))
651 template->sub.eth.flags.two_tags = 1;
652 template->sub.eth.flags.outer_vlan_id_any = 1;
653 template->sub.eth.flags.inner_vlan_id_any = 1;
655 else if (unformat (input, "any"))
657 template->sub.eth.flags.one_tag = 1;
658 template->sub.eth.flags.outer_vlan_id_any = 1;
660 else if (unformat (input, "%d inner-dot1q any", &outer_vlan))
662 template->sub.eth.flags.two_tags = 1;
663 template->sub.eth.flags.inner_vlan_id_any = 1;
664 template->sub.eth.outer_vlan_id = outer_vlan;
666 else if (unformat (input, "%d inner-dot1q %d", &outer_vlan, &inner_vlan))
668 template->sub.eth.flags.two_tags = 1;
669 template->sub.eth.outer_vlan_id = outer_vlan;
670 template->sub.eth.inner_vlan_id = inner_vlan;
672 else if (unformat (input, "%d", &outer_vlan))
674 template->sub.eth.flags.one_tag = 1;
675 template->sub.eth.outer_vlan_id = outer_vlan;
679 error = clib_error_return (0, "expected dot1q config, got `%U'",
680 format_unformat_error, input);
684 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
686 if (unformat (input, "exact-match"))
688 template->sub.eth.flags.exact_match = 1;
696 static clib_error_t *
697 create_sub_interfaces (vlib_main_t * vm,
698 unformat_input_t * input, vlib_cli_command_t * cmd)
700 vnet_main_t *vnm = vnet_get_main ();
701 clib_error_t *error = 0;
702 u32 hw_if_index, sw_if_index;
703 vnet_hw_interface_t *hi;
704 u32 id, id_min, id_max;
705 vnet_sw_interface_t template;
708 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
710 error = clib_error_return (0, "unknown interface `%U'",
711 format_unformat_error, input);
715 clib_memset (&template, 0, sizeof (template));
716 template.sub.eth.raw_flags = 0;
718 if (unformat (input, "%d default", &id_min))
721 template.sub.eth.flags.default_sub = 1;
723 else if (unformat (input, "%d untagged", &id_min))
726 template.sub.eth.flags.no_tags = 1;
727 template.sub.eth.flags.exact_match = 1;
729 else if (unformat (input, "%d dot1q", &id_min))
731 /* parse dot1q config */
733 error = parse_vlan_sub_interfaces (input, &template);
737 else if (unformat (input, "%d dot1ad", &id_min))
739 /* parse dot1ad config */
741 template.sub.eth.flags.dot1ad = 1;
742 error = parse_vlan_sub_interfaces (input, &template);
746 else if (unformat (input, "%d-%d", &id_min, &id_max))
748 template.sub.eth.flags.one_tag = 1;
749 template.sub.eth.flags.exact_match = 1;
753 else if (unformat (input, "%d", &id_min))
756 template.sub.eth.flags.one_tag = 1;
757 template.sub.eth.outer_vlan_id = id_min;
758 template.sub.eth.flags.exact_match = 1;
763 error = clib_error_return (0, "expected ID or ID MIN-MAX, got `%U'",
764 format_unformat_error, input);
768 hi = vnet_get_hw_interface (vnm, hw_if_index);
770 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
773 clib_error_return (0,
774 "not allowed as %v belong to a BondEthernet interface",
779 for (id = id_min; id <= id_max; id++)
782 vnet_interface_main_t *im = &vnm->interface_main;
783 u64 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
786 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
790 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
791 hi->sw_if_index, id);
795 template.type = VNET_SW_INTERFACE_TYPE_SUB;
796 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
797 template.sup_sw_if_index = hi->sw_if_index;
798 template.sub.id = id;
800 template.sub.eth.outer_vlan_id = id;
802 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
806 kp = clib_mem_alloc (sizeof (*kp));
807 *kp = sup_and_sub_key;
809 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
810 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
811 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
812 vnet_get_main (), sw_if_index);
820 * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
821 * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
822 * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
823 * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
824 * but this is not recommended.
826 * This command has several variations:
827 * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
828 * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
830 * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
831 * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
832 * match any other subinterfaces should be sent to this subinterface.
834 * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
835 * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
836 * to this subinterface.
838 * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
839 * subinterfaces to handle a range of VLAN IDs.
841 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
842 * Use this command to specify the outer VLAN ID, to either be explicit or to make the
843 * VLAN ID different from the '<em>subId</em>'.
845 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
846 * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
849 * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explicitly entered, subinterfaces
850 * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
851 * default. If '<em>exact-match</em>' is specified, packets must have the same number of
852 * VLAN tags as the configuration. For non-exact-match, packets must at least that number
853 * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
854 * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
855 * entered, then the default behavior is exact-match.
857 * Use the '<em>show interface</em>' command to display all subinterfaces.
861 * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
862 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
864 * The previous example is shorthand and is equivalent to:
865 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
868 * Example of how to create a subinterface number that is different from the VLAN ID:
869 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
872 * Examples of how to create q-in-q and q-in-any subinterfaces:
873 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
874 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
876 * Examples of how to create dot1ad interfaces:
877 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
878 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
881 * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
882 * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
883 * is non-exact match:
884 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
886 * However, the same packet would NOT match this interface because '<em>exact-match</em>'
887 * is specified and only one VLAN is configured, but packet contains two VLANs:
888 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
891 * Example of how to created a subinterface to process untagged packets:
892 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
894 * Example of how to created a subinterface to process any packet with a VLAN ID that
895 * does not match any other subinterface:
896 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
898 * When subinterfaces are created, they are in the down state. Example of how to
899 * enable a newly created subinterface:
900 * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
904 VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
905 .path = "create sub-interfaces",
906 .short_help = "create sub-interfaces <interface> "
907 "{<subId> [default|untagged]} | "
908 "{<subId>-<subId>} | "
909 "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
910 .function = create_sub_interfaces,
914 static clib_error_t *
915 set_state (vlib_main_t * vm,
916 unformat_input_t * input, vlib_cli_command_t * cmd)
918 vnet_main_t *vnm = vnet_get_main ();
920 u32 sw_if_index, flags;
923 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
925 error = clib_error_return (0, "unknown interface `%U'",
926 format_unformat_error, input);
930 if (!unformat (input, "%U", unformat_vnet_sw_interface_flags, &flags))
932 error = clib_error_return (0, "unknown flags `%U'",
933 format_unformat_error, input);
937 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
956 * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
957 * Example of how to configure the admin state of an interface to
959 * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
962 VLIB_CLI_COMMAND (set_state_command, static) = {
963 .path = "set interface state",
964 .short_help = "set interface state <interface> [up|down|punt|enable]",
965 .function = set_state,
969 static clib_error_t *
970 set_unnumbered (vlib_main_t * vm,
971 unformat_input_t * input, vlib_cli_command_t * cmd)
973 vnet_main_t *vnm = vnet_get_main ();
974 u32 unnumbered_sw_if_index = ~0;
975 u32 inherit_from_sw_if_index = ~0;
978 if (unformat (input, "%U use %U",
979 unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
980 unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
982 else if (unformat (input, "del %U",
983 unformat_vnet_sw_interface, vnm,
984 &unnumbered_sw_if_index))
987 return clib_error_return (0, "parse error '%U'",
988 format_unformat_error, input);
990 if (~0 == unnumbered_sw_if_index)
991 return clib_error_return (0, "Specify the unnumbered interface");
992 if (enable && ~0 == inherit_from_sw_if_index)
993 return clib_error_return (0, "When enabling unnumbered specify the"
994 " IP enabled interface that it uses");
996 int rv = vnet_sw_interface_update_unnumbered (
997 unnumbered_sw_if_index, inherit_from_sw_if_index, enable);
1004 case VNET_API_ERROR_UNEXPECTED_INTF_STATE:
1005 return clib_error_return (
1007 "When enabling unnumbered both interfaces must be in the same tables");
1010 return clib_error_return (
1011 0, "vnet_sw_interface_update_unnumbered returned %d", rv);
1018 VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
1019 .path = "set interface unnumbered",
1020 .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
1021 .function = set_unnumbered,
1027 static clib_error_t *
1028 set_hw_class (vlib_main_t * vm,
1029 unformat_input_t * input, vlib_cli_command_t * cmd)
1031 vnet_main_t *vnm = vnet_get_main ();
1032 vnet_interface_main_t *im = &vnm->interface_main;
1033 clib_error_t *error;
1034 u32 hw_if_index, hw_class_index;
1037 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1039 error = clib_error_return (0, "unknown hardware interface `%U'",
1040 format_unformat_error, input);
1044 if (!unformat_user (input, unformat_hash_string,
1045 im->hw_interface_class_by_name, &hw_class_index))
1047 error = clib_error_return (0, "unknown hardware class `%U'",
1048 format_unformat_error, input);
1052 error = vnet_hw_interface_set_class (vnm, hw_if_index, hw_class_index);
1061 VLIB_CLI_COMMAND (set_hw_class_command, static) = {
1062 .path = "set interface hw-class",
1063 .short_help = "Set interface hardware class",
1064 .function = set_hw_class,
1068 static clib_error_t *
1069 vnet_interface_cli_init (vlib_main_t * vm)
1074 VLIB_INIT_FUNCTION (vnet_interface_cli_init);
1076 static clib_error_t *
1077 renumber_interface_command_fn (vlib_main_t * vm,
1078 unformat_input_t * input,
1079 vlib_cli_command_t * cmd)
1082 u32 new_dev_instance;
1083 vnet_main_t *vnm = vnet_get_main ();
1086 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1087 return clib_error_return (0, "unknown hardware interface `%U'",
1088 format_unformat_error, input);
1090 if (!unformat (input, "%d", &new_dev_instance))
1091 return clib_error_return (0, "new dev instance missing");
1093 rv = vnet_interface_name_renumber (hw_if_index, new_dev_instance);
1101 return clib_error_return (0, "vnet_interface_name_renumber returned %d",
1111 VLIB_CLI_COMMAND (renumber_interface_command, static) = {
1112 .path = "renumber interface",
1113 .short_help = "renumber interface <interface> <new-dev-instance>",
1114 .function = renumber_interface_command_fn,
1118 static clib_error_t *
1119 promiscuous_cmd (vlib_main_t * vm,
1120 unformat_input_t * input, vlib_cli_command_t * cmd)
1122 vnet_main_t *vnm = vnet_get_main ();
1124 u32 flags = ETHERNET_INTERFACE_FLAG_ACCEPT_ALL;
1125 ethernet_main_t *em = ðernet_main;
1126 ethernet_interface_t *eif;
1128 if (unformat (input, "on %U",
1129 unformat_vnet_hw_interface, vnm, &hw_if_index))
1131 else if (unformat (input, "off %U",
1132 unformat_ethernet_interface, vnm, &hw_if_index))
1135 return clib_error_return (0, "unknown input `%U'",
1136 format_unformat_error, input);
1138 eif = ethernet_get_interface (em, hw_if_index);
1140 return clib_error_return (0, "not supported");
1142 ethernet_set_flags (vnm, hw_if_index, flags);
1147 VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
1148 .path = "set interface promiscuous",
1149 .short_help = "set interface promiscuous [on|off] <interface>",
1150 .function = promiscuous_cmd,
1154 static clib_error_t *
1155 mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1157 vnet_main_t *vnm = vnet_get_main ();
1158 u32 hw_if_index, sw_if_index, mtu;
1159 ethernet_main_t *em = ðernet_main;
1160 u32 mtus[VNET_N_MTU] = { 0, 0, 0, 0 };
1162 if (unformat (input, "%d %U", &mtu,
1163 unformat_vnet_hw_interface, vnm, &hw_if_index))
1166 * Change physical MTU on interface. Only supported for Ethernet
1169 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1170 ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
1173 return clib_error_return (0, "not supported");
1175 if (mtu < hi->min_supported_packet_bytes)
1176 return clib_error_return (0, "Invalid mtu (%d): "
1177 "must be >= min pkt bytes (%d)", mtu,
1178 hi->min_supported_packet_bytes);
1180 if (mtu > hi->max_supported_packet_bytes)
1181 return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
1182 hi->max_supported_packet_bytes);
1184 vnet_hw_interface_set_mtu (vnm, hw_if_index, mtu);
1187 else if (unformat (input, "packet %d %U", &mtu,
1188 unformat_vnet_sw_interface, vnm, &sw_if_index))
1189 /* Set default packet MTU (including L3 header */
1190 mtus[VNET_MTU_L3] = mtu;
1191 else if (unformat (input, "ip4 %d %U", &mtu,
1192 unformat_vnet_sw_interface, vnm, &sw_if_index))
1193 mtus[VNET_MTU_IP4] = mtu;
1194 else if (unformat (input, "ip6 %d %U", &mtu,
1195 unformat_vnet_sw_interface, vnm, &sw_if_index))
1196 mtus[VNET_MTU_IP6] = mtu;
1197 else if (unformat (input, "mpls %d %U", &mtu,
1198 unformat_vnet_sw_interface, vnm, &sw_if_index))
1199 mtus[VNET_MTU_MPLS] = mtu;
1201 return clib_error_return (0, "unknown input `%U'",
1202 format_unformat_error, input);
1204 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, mtus);
1211 VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
1212 .path = "set interface mtu",
1213 .short_help = "set interface mtu [packet|ip4|ip6|mpls] <value> <interface>",
1214 .function = mtu_cmd,
1218 static clib_error_t *
1219 show_interface_sec_mac_addr_fn (vlib_main_t * vm, unformat_input_t * input,
1220 vlib_cli_command_t * cmd)
1222 vnet_main_t *vnm = vnet_get_main ();
1223 vnet_interface_main_t *im = &vnm->interface_main;
1224 ethernet_main_t *em = ðernet_main;
1225 u32 sw_if_index = ~0;
1226 vnet_sw_interface_t *si, *sorted_sis = 0;
1228 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1230 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
1231 vec_add1 (sorted_sis, si[0]);
1234 /* if an interface name was not passed, get all interfaces */
1235 if (vec_len (sorted_sis) == 0)
1238 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1239 _vec_len (sorted_sis) = 0;
1241 pool_foreach (si, im->sw_interfaces)
1243 int visible = vnet_swif_is_api_visible (si);
1245 vec_add1 (sorted_sis, si[0]);
1249 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
1252 vec_foreach (si, sorted_sis)
1254 vnet_sw_interface_t *sup_si;
1255 ethernet_interface_t *ei;
1257 sup_si = vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1258 ei = ethernet_get_interface (em, sup_si->hw_if_index);
1260 vlib_cli_output (vm, "%U (%s):",
1261 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
1262 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
1265 if (ei && ei->secondary_addrs)
1267 ethernet_interface_address_t *sec_addr;
1269 vec_foreach (sec_addr, ei->secondary_addrs)
1271 vlib_cli_output (vm, " %U", format_mac_address_t, &sec_addr->mac);
1276 vec_free (sorted_sis);
1281 * This command is used to display interface secondary mac addresses.
1284 * Example of how to display interface secondary mac addresses:
1285 * @cliexstart{show interface secondary-mac-address}
1289 VLIB_CLI_COMMAND (show_interface_sec_mac_addr, static) = {
1290 .path = "show interface secondary-mac-address",
1291 .short_help = "show interface secondary-mac-address [<interface>]",
1292 .function = show_interface_sec_mac_addr_fn,
1296 static clib_error_t *
1297 interface_add_del_mac_address (vlib_main_t * vm, unformat_input_t * input,
1298 vlib_cli_command_t * cmd)
1300 vnet_main_t *vnm = vnet_get_main ();
1301 vnet_sw_interface_t *si = NULL;
1302 clib_error_t *error = 0;
1303 u32 sw_if_index = ~0;
1307 is_add = is_del = 0;
1309 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1311 error = clib_error_return (0, "unknown interface `%U'",
1312 format_unformat_error, input);
1315 if (!unformat_user (input, unformat_ethernet_address, mac))
1317 error = clib_error_return (0, "expected mac address `%U'",
1318 format_unformat_error, input);
1322 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1324 if (unformat (input, "add"))
1326 else if (unformat (input, "del"))
1332 if (is_add == is_del)
1334 error = clib_error_return (0, "must choose one of add or del");
1338 si = vnet_get_sw_interface (vnm, sw_if_index);
1340 vnet_hw_interface_add_del_mac_address (vnm, si->hw_if_index, mac, is_add);
1347 * The '<em>set interface secondary-mac-address </em>' command allows adding
1348 * or deleting extra MAC addresses on a given interface without changing the
1349 * default MAC address. This could allow packets sent to these MAC addresses
1350 * to be received without setting the interface to promiscuous mode.
1351 * Not all interfaces support this operation. The ones that do are mostly
1352 * hardware NICs, though virtio does also.
1356 * Example of how to add a secondary MAC Address on an interface:
1357 * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 add}
1358 * Example of how to delete a secondary MAC address from an interface:
1359 * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 del}
1363 VLIB_CLI_COMMAND (interface_add_del_mac_address_cmd, static) = {
1364 .path = "set interface secondary-mac-address",
1365 .short_help = "set interface secondary-mac-address <interface> <mac-address> [(add|del)]",
1366 .function = interface_add_del_mac_address,
1370 static clib_error_t *
1371 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
1372 vlib_cli_command_t * cmd)
1374 vnet_main_t *vnm = vnet_get_main ();
1375 vnet_sw_interface_t *si = NULL;
1376 clib_error_t *error = 0;
1377 u32 sw_if_index = ~0;
1380 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1382 error = clib_error_return (0, "unknown interface `%U'",
1383 format_unformat_error, input);
1386 if (!unformat_user (input, unformat_ethernet_address, mac))
1388 error = clib_error_return (0, "expected mac address `%U'",
1389 format_unformat_error, input);
1392 si = vnet_get_sw_interface (vnm, sw_if_index);
1393 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
1399 * The '<em>set interface mac address </em>' command allows to set MAC address of given interface.
1400 * In case of NIC interfaces the one has to support MAC address change. A side effect of MAC address
1401 * change are changes of MAC addresses in FIB tables (ipv4 and ipv6).
1405 * Example of how to change MAC Address of interface:
1406 * @cliexcmd{set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01}
1407 * @cliexcmd{set interface mac address host-vpp0 aa:bb:cc:dd:ee:02}
1408 * @cliexcmd{set interface mac address tap-0 aa:bb:cc:dd:ee:03}
1409 * @cliexcmd{set interface mac address pg0 aa:bb:cc:dd:ee:04}
1413 VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
1414 .path = "set interface mac address",
1415 .short_help = "set interface mac address <interface> <mac-address>",
1416 .function = set_interface_mac_address,
1420 static clib_error_t *
1421 set_tag (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1423 vnet_main_t *vnm = vnet_get_main ();
1424 u32 sw_if_index = ~0;
1427 if (!unformat (input, "%U %s", unformat_vnet_sw_interface,
1428 vnm, &sw_if_index, &tag))
1429 return clib_error_return (0, "unknown input `%U'",
1430 format_unformat_error, input);
1432 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
1438 VLIB_CLI_COMMAND (set_tag_command, static) = {
1439 .path = "set interface tag",
1440 .short_help = "set interface tag <interface> <tag>",
1441 .function = set_tag,
1445 static clib_error_t *
1446 clear_tag (vlib_main_t * vm, unformat_input_t * input,
1447 vlib_cli_command_t * cmd)
1449 vnet_main_t *vnm = vnet_get_main ();
1450 u32 sw_if_index = ~0;
1452 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1453 return clib_error_return (0, "unknown input `%U'",
1454 format_unformat_error, input);
1456 vnet_clear_sw_interface_tag (vnm, sw_if_index);
1462 VLIB_CLI_COMMAND (clear_tag_command, static) = {
1463 .path = "clear interface tag",
1464 .short_help = "clear interface tag <interface>",
1465 .function = clear_tag,
1469 static clib_error_t *
1470 set_ip_directed_broadcast (vlib_main_t * vm,
1471 unformat_input_t * input, vlib_cli_command_t * cmd)
1473 vnet_main_t *vnm = vnet_get_main ();
1474 u32 sw_if_index = ~0;
1477 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index));
1478 else if (unformat (input, "enable"))
1480 else if (unformat (input, "disable"))
1483 return clib_error_return (0, "unknown input: `%U'",
1484 format_unformat_error, input);
1486 if (~0 == sw_if_index)
1487 return clib_error_return (0, "specify an interface: `%U'",
1488 format_unformat_error, input);
1490 vnet_sw_interface_ip_directed_broadcast (vnm, sw_if_index, enable);
1496 * This command is used to enable/disable IP directed broadcast
1497 * If directed broadcast is enabled a packet sent to the interface's
1498 * subnet broadcast address will be sent L2 broadcast on the interface,
1499 * otherwise it is dropped.
1502 VLIB_CLI_COMMAND (set_ip_directed_broadcast_command, static) = {
1503 .path = "set interface ip directed-broadcast",
1504 .short_help = "set interface enable <interface> <enable|disable>",
1505 .function = set_ip_directed_broadcast,
1510 set_hw_interface_change_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1511 u8 queue_id_valid, u32 queue_id,
1512 vnet_hw_if_rx_mode mode)
1514 clib_error_t *error = 0;
1515 vnet_hw_interface_t *hw;
1516 u32 *queue_indices = 0;
1518 hw = vnet_get_hw_interface (vnm, hw_if_index);
1524 vnet_hw_if_get_rx_queue_index_by_id (vnm, hw_if_index, queue_id);
1525 if (queue_index == ~0)
1526 return clib_error_return (0, "unknown queue %u on interface %s",
1527 queue_id, hw->name);
1528 vec_add1 (queue_indices, queue_index);
1531 queue_indices = hw->rx_queue_indices;
1533 for (int i = 0; i < vec_len (queue_indices); i++)
1535 int rv = vnet_hw_if_set_rx_queue_mode (vnm, queue_indices[i], mode);
1541 if (queue_indices != hw->rx_queue_indices)
1542 vec_free (queue_indices);
1543 vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1547 static clib_error_t *
1548 set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
1549 vlib_cli_command_t * cmd)
1551 clib_error_t *error = 0;
1552 unformat_input_t _line_input, *line_input = &_line_input;
1553 vnet_main_t *vnm = vnet_get_main ();
1554 u32 hw_if_index = (u32) ~ 0;
1555 u32 queue_id = (u32) ~ 0;
1556 vnet_hw_if_rx_mode mode = VNET_HW_IF_RX_MODE_UNKNOWN;
1557 u8 queue_id_valid = 0;
1559 if (!unformat_user (input, unformat_line_input, line_input))
1562 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1565 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1567 else if (unformat (line_input, "queue %d", &queue_id))
1569 else if (unformat (line_input, "polling"))
1570 mode = VNET_HW_IF_RX_MODE_POLLING;
1571 else if (unformat (line_input, "interrupt"))
1572 mode = VNET_HW_IF_RX_MODE_INTERRUPT;
1573 else if (unformat (line_input, "adaptive"))
1574 mode = VNET_HW_IF_RX_MODE_ADAPTIVE;
1577 error = clib_error_return (0, "parse error: '%U'",
1578 format_unformat_error, line_input);
1579 unformat_free (line_input);
1584 unformat_free (line_input);
1586 if (hw_if_index == (u32) ~ 0)
1587 return clib_error_return (0, "please specify valid interface name");
1589 if (mode == VNET_HW_IF_RX_MODE_UNKNOWN)
1590 return clib_error_return (0, "please specify valid rx-mode");
1592 error = set_hw_interface_change_rx_mode (vnm, hw_if_index, queue_id_valid,
1599 * This command is used to assign the RX packet processing mode (polling,
1600 * interrupt, adaptive) of the a given interface, and optionally a
1601 * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
1602 * is applied to all queues of the interface. Not all interfaces support
1603 * all modes. To display the current rx-mode use the command
1604 * '<em>show interface rx-placement</em>'.
1607 * Example of how to assign rx-mode to all queues on an interface:
1608 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
1609 * Example of how to assign rx-mode to one queue of an interface:
1610 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
1611 * Example of how to display the rx-mode of all interfaces:
1612 * @cliexstart{show interface rx-placement}
1613 * Thread 1 (vpp_wk_0):
1615 * GigabitEthernet7/0/0 queue 0 (polling)
1616 * node vhost-user-input:
1617 * VirtualEthernet0/0/12 queue 0 (interrupt)
1618 * VirtualEthernet0/0/12 queue 2 (polling)
1619 * VirtualEthernet0/0/13 queue 0 (polling)
1620 * VirtualEthernet0/0/13 queue 2 (polling)
1621 * Thread 2 (vpp_wk_1):
1623 * GigabitEthernet7/0/1 queue 0 (polling)
1624 * node vhost-user-input:
1625 * VirtualEthernet0/0/12 queue 1 (polling)
1626 * VirtualEthernet0/0/12 queue 3 (polling)
1627 * VirtualEthernet0/0/13 queue 1 (polling)
1628 * VirtualEthernet0/0/13 queue 3 (polling)
1632 VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
1633 .path = "set interface rx-mode",
1634 .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
1635 .function = set_interface_rx_mode,
1639 static clib_error_t *
1640 show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
1641 vlib_cli_command_t * cmd)
1644 vnet_main_t *vnm = vnet_get_main ();
1645 vnet_hw_if_rx_queue_t **all_queues = 0;
1646 vnet_hw_if_rx_queue_t **qptr;
1647 vnet_hw_if_rx_queue_t *q;
1648 pool_foreach (q, vnm->interface_main.hw_if_rx_queues)
1649 vec_add1 (all_queues, q);
1650 vec_sort_with_function (all_queues, vnet_hw_if_rxq_cmp_cli_api);
1653 vec_foreach (qptr, all_queues)
1655 u32 current_thread = qptr[0]->thread_index;
1656 u32 hw_if_index = qptr[0]->hw_if_index;
1657 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1658 u32 current_node = hw_if->input_node_index;
1659 if (current_node != prev_node)
1660 s = format (s, " node %U:\n", format_vlib_node_name, vm, current_node);
1661 s = format (s, " %U queue %u (%U)\n", format_vnet_sw_if_index_name,
1662 vnm, hw_if->sw_if_index, qptr[0]->queue_id,
1663 format_vnet_hw_if_rx_mode, qptr[0]->mode);
1664 if (qptr == all_queues + vec_len (all_queues) - 1 ||
1665 current_thread != qptr[1]->thread_index)
1667 vlib_cli_output (vm, "Thread %u (%s):\n%v", current_thread,
1668 vlib_worker_threads[current_thread].name, s);
1669 vec_reset_length (s);
1671 prev_node = current_node;
1674 vec_free (all_queues);
1679 * This command is used to display the interface and queue worker
1683 * Example of how to display the interface placement:
1684 * @cliexstart{show interface rx-placement}
1685 * Thread 1 (vpp_wk_0):
1687 * GigabitEthernet7/0/0 queue 0 (polling)
1688 * node vhost-user-input:
1689 * VirtualEthernet0/0/12 queue 0 (polling)
1690 * VirtualEthernet0/0/12 queue 2 (polling)
1691 * VirtualEthernet0/0/13 queue 0 (polling)
1692 * VirtualEthernet0/0/13 queue 2 (polling)
1693 * Thread 2 (vpp_wk_1):
1695 * GigabitEthernet7/0/1 queue 0 (polling)
1696 * node vhost-user-input:
1697 * VirtualEthernet0/0/12 queue 1 (polling)
1698 * VirtualEthernet0/0/12 queue 3 (polling)
1699 * VirtualEthernet0/0/13 queue 1 (polling)
1700 * VirtualEthernet0/0/13 queue 3 (polling)
1704 VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
1705 .path = "show interface rx-placement",
1706 .short_help = "show interface rx-placement",
1707 .function = show_interface_rx_placement_fn,
1711 set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
1712 u32 thread_index, u8 is_main)
1714 vnet_main_t *vnm = vnet_get_main ();
1715 vnet_device_main_t *vdm = &vnet_device_main;
1716 vnet_hw_interface_t *hw;
1722 thread_index += vdm->first_worker_thread_index;
1724 if (thread_index > vdm->last_worker_thread_index)
1725 return clib_error_return (0,
1726 "please specify valid worker thread or main");
1728 hw = vnet_get_hw_interface (vnm, hw_if_index);
1731 vnet_hw_if_get_rx_queue_index_by_id (vnm, hw_if_index, queue_id);
1732 if (queue_index == ~0)
1733 return clib_error_return (0, "unknown queue %u on interface %s", queue_id,
1735 vnet_hw_if_set_rx_queue_thread_index (vnm, queue_index, thread_index);
1736 vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1740 static clib_error_t *
1741 set_interface_rx_placement (vlib_main_t *vm, unformat_input_t *input,
1742 vlib_cli_command_t *cmd)
1744 clib_error_t *error = 0;
1745 unformat_input_t _line_input, *line_input = &_line_input;
1746 vnet_main_t *vnm = vnet_get_main ();
1747 u32 hw_if_index = (u32) ~ 0;
1748 u32 queue_id = (u32) 0;
1749 u32 thread_index = (u32) ~ 0;
1752 if (!unformat_user (input, unformat_line_input, line_input))
1755 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1758 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1760 else if (unformat (line_input, "queue %d", &queue_id))
1762 else if (unformat (line_input, "main", &thread_index))
1764 else if (unformat (line_input, "worker %d", &thread_index))
1768 error = clib_error_return (0, "parse error: '%U'",
1769 format_unformat_error, line_input);
1770 unformat_free (line_input);
1775 unformat_free (line_input);
1777 if (hw_if_index == (u32) ~ 0)
1778 return clib_error_return (0, "please specify valid interface name");
1780 error = set_hw_interface_rx_placement (hw_if_index, queue_id, thread_index,
1787 * This command is used to assign a given interface, and optionally a
1788 * given queue, to a different thread. If the '<em>queue</em>' is not provided,
1789 * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
1790 * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
1793 * Example of how to display the interface placement:
1794 * @cliexstart{show interface rx-placement}
1795 * Thread 1 (vpp_wk_0):
1797 * GigabitEthernet7/0/0 queue 0 (polling)
1798 * node vhost-user-input:
1799 * VirtualEthernet0/0/12 queue 0 (polling)
1800 * VirtualEthernet0/0/12 queue 2 (polling)
1801 * VirtualEthernet0/0/13 queue 0 (polling)
1802 * VirtualEthernet0/0/13 queue 2 (polling)
1803 * Thread 2 (vpp_wk_1):
1805 * GigabitEthernet7/0/1 queue 0 (polling)
1806 * node vhost-user-input:
1807 * VirtualEthernet0/0/12 queue 1 (polling)
1808 * VirtualEthernet0/0/12 queue 3 (polling)
1809 * VirtualEthernet0/0/13 queue 1 (polling)
1810 * VirtualEthernet0/0/13 queue 3 (polling)
1812 * Example of how to assign a interface and queue to a worker thread:
1813 * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
1814 * Example of how to display the interface placement:
1815 * @cliexstart{show interface rx-placement}
1816 * Thread 1 (vpp_wk_0):
1818 * GigabitEthernet7/0/0 queue 0 (polling)
1819 * node vhost-user-input:
1820 * VirtualEthernet0/0/12 queue 0 (polling)
1821 * VirtualEthernet0/0/12 queue 1 (polling)
1822 * VirtualEthernet0/0/12 queue 2 (polling)
1823 * VirtualEthernet0/0/13 queue 0 (polling)
1824 * VirtualEthernet0/0/13 queue 2 (polling)
1825 * Thread 2 (vpp_wk_1):
1827 * GigabitEthernet7/0/1 queue 0 (polling)
1828 * node vhost-user-input:
1829 * VirtualEthernet0/0/12 queue 3 (polling)
1830 * VirtualEthernet0/0/13 queue 1 (polling)
1831 * VirtualEthernet0/0/13 queue 3 (polling)
1835 VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
1836 .path = "set interface rx-placement",
1837 .short_help = "set interface rx-placement <interface> [queue <n>] "
1838 "[worker <n> | main]",
1839 .function = set_interface_rx_placement,
1845 set_hw_interface_tx_queue (u32 hw_if_index, u32 queue_id, uword *bitmap)
1847 vnet_main_t *vnm = vnet_get_main ();
1848 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1849 vnet_hw_if_tx_queue_t *txq;
1853 /* highest set bit in bitmap should not exceed last worker thread index */
1854 thread_index = clib_bitmap_last_set (bitmap);
1855 if ((thread_index != ~0) && (thread_index >= vtm->n_vlib_mains))
1856 return VNET_API_ERROR_INVALID_VALUE;
1859 vnet_hw_if_get_tx_queue_index_by_id (vnm, hw_if_index, queue_id);
1860 if (queue_index == ~0)
1861 return VNET_API_ERROR_INVALID_QUEUE;
1863 txq = vnet_hw_if_get_tx_queue (vnm, queue_index);
1865 // free the existing bitmap
1866 if (clib_bitmap_count_set_bits (txq->threads))
1868 txq->shared_queue = 0;
1869 clib_bitmap_free (txq->threads);
1872 clib_bitmap_foreach (thread_index, bitmap)
1873 vnet_hw_if_tx_queue_assign_thread (vnm, queue_index, thread_index);
1875 vnet_hw_if_update_runtime_data (vnm, hw_if_index);
1879 static clib_error_t *
1880 set_interface_tx_queue (vlib_main_t *vm, unformat_input_t *input,
1881 vlib_cli_command_t *cmd)
1883 clib_error_t *error = 0;
1884 unformat_input_t _line_input, *line_input = &_line_input;
1885 vnet_main_t *vnm = vnet_get_main ();
1886 u32 hw_if_index = (u32) ~0;
1887 u32 queue_id = (u32) 0;
1891 if (!unformat_user (input, unformat_line_input, line_input))
1894 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1896 if (unformat (line_input, "%U", unformat_vnet_hw_interface, vnm,
1899 else if (unformat (line_input, "queue %d", &queue_id))
1901 else if (unformat (line_input, "threads %U", unformat_bitmap_list,
1906 error = clib_error_return (0, "parse error: '%U'",
1907 format_unformat_error, line_input);
1908 unformat_free (line_input);
1913 unformat_free (line_input);
1915 if (hw_if_index == (u32) ~0)
1917 error = clib_error_return (0, "please specify valid interface name");
1921 rv = set_hw_interface_tx_queue (hw_if_index, queue_id, bitmap);
1925 case VNET_API_ERROR_INVALID_VALUE:
1926 error = clib_error_return (
1927 0, "please specify valid thread(s) - last thread index %u",
1928 clib_bitmap_last_set (bitmap));
1930 case VNET_API_ERROR_INVALID_QUEUE:
1931 error = clib_error_return (
1932 0, "unknown queue %u on interface %s", queue_id,
1933 vnet_get_hw_interface (vnet_get_main (), hw_if_index)->name);
1940 clib_bitmap_free (bitmap);
1944 VLIB_CLI_COMMAND (cmd_set_if_tx_queue, static) = {
1945 .path = "set interface tx-queue",
1946 .short_help = "set interface tx-queue <interface> queue <n> "
1948 .function = set_interface_tx_queue,
1953 set_interface_rss_queues (vlib_main_t * vm, u32 hw_if_index,
1954 clib_bitmap_t * bitmap)
1956 vnet_main_t *vnm = vnet_get_main ();
1957 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1959 return vnet_hw_interface_set_rss_queues (vnm, hi, bitmap);
1962 static clib_error_t *
1963 set_interface_rss_queues_fn (vlib_main_t * vm,
1964 unformat_input_t * input,
1965 vlib_cli_command_t * cmd)
1967 clib_error_t *error = 0;
1968 unformat_input_t _line_input, *line_input = &_line_input;
1969 vnet_main_t *vnm = vnet_get_main ();
1970 u32 hw_if_index = (u32) ~ 0;
1971 clib_bitmap_t *bitmap = NULL;
1973 if (!unformat_user (input, unformat_line_input, line_input))
1976 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1979 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1982 if (unformat (line_input, "list %U", unformat_bitmap_list, &bitmap))
1986 error = clib_error_return (0, "parse error: '%U'",
1987 format_unformat_error, line_input);
1988 unformat_free (line_input);
1993 unformat_free (line_input);
1995 if (hw_if_index == (u32) ~ 0)
1997 error = clib_error_return (0, "please specify valid interface name");
2003 error = clib_error_return (0, "please specify the valid rss queues");
2007 error = set_interface_rss_queues (vm, hw_if_index, bitmap);
2011 clib_bitmap_free (bitmap);
2017 * This command is used to set the rss queues of a given interface
2018 * Not all the interfaces support this operation.
2019 * To display the current rss queues, use the command
2020 * '<em>show hardware-interfaces</em>'.
2023 * Example of how to set the rss queues to 0,2-5,7 of an interface:
2024 * @cliexstart{set interface rss queues VirtualFunctionEthernet18/1/0 list 0,2-5,7}
2028 VLIB_CLI_COMMAND (cmd_set_interface_rss_queues,static) = {
2029 .path = "set interface rss queues",
2030 .short_help = "set interface rss queues <interface> <list <queue-list>>",
2031 .function = set_interface_rss_queues_fn,
2036 format_vnet_pcap (u8 * s, va_list * args)
2038 vnet_pcap_t *pp = va_arg (*args, vnet_pcap_t *);
2039 int type = va_arg (*args, int);
2044 if (pp->pcap_rx_enable)
2046 s = format (s, "rx");
2049 if (pp->pcap_tx_enable)
2052 s = format (s, " and ");
2053 s = format (s, "tx");
2056 if (pp->pcap_drop_enable)
2059 s = format (s, " and ");
2060 s = format (s, "drop");
2065 s = format (s, "unknown type %d!", type);
2071 vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
2073 vlib_main_t *vm = vlib_get_main ();
2074 vnet_main_t *vnm = vnet_get_main ();
2075 vnet_pcap_t *pp = &vnm->pcap;
2076 pcap_main_t *pm = &pp->pcap_main;
2077 vnet_classify_main_t *cm = &vnet_classify_main;
2081 if (pp->pcap_rx_enable || pp->pcap_tx_enable || pp->pcap_drop_enable)
2084 (vm, "pcap %U dispatch capture enabled: %d of %d pkts...",
2085 format_vnet_pcap, pp, 0 /* print type */ ,
2086 pm->n_packets_captured, pm->n_packets_to_capture);
2087 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2090 vlib_cli_output (vm, "pcap dispatch capture disabled");
2095 /* Consistency checks */
2097 /* Enable w/ capture already enabled not allowed */
2098 if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
2099 && (a->rx_enable + a->tx_enable + a->drop_enable))
2100 return VNET_API_ERROR_INVALID_VALUE;
2102 /* Disable capture with capture already disabled, not interesting */
2103 if (((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable) ==
2105 ((a->rx_enable + a->tx_enable + a->drop_enable == 0)))
2106 return VNET_API_ERROR_VALUE_EXIST;
2108 /* Change number of packets to capture while capturing */
2109 if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
2110 && (a->rx_enable + a->tx_enable + a->drop_enable)
2111 && (pm->n_packets_to_capture != a->packets_to_capture))
2112 return VNET_API_ERROR_INVALID_VALUE_2;
2114 /* Classify filter specified, but no classify filter configured */
2115 if ((a->rx_enable + a->tx_enable + a->drop_enable) && a->filter &&
2116 (!cm->classify_table_index_by_sw_if_index ||
2117 cm->classify_table_index_by_sw_if_index[0] == ~0))
2118 return VNET_API_ERROR_NO_SUCH_LABEL;
2120 if (a->rx_enable + a->tx_enable + a->drop_enable)
2122 void *save_pcap_data;
2124 /* Sanity check max bytes per pkt */
2125 if (a->max_bytes_per_pkt < 32 || a->max_bytes_per_pkt > 9000)
2126 return VNET_API_ERROR_INVALID_MEMORY_SIZE;
2128 /* Clean up from previous run, if any */
2129 vec_reset_length (pm->pcap_data);
2131 /* Throw away the data buffer? */
2133 vec_free (pm->pcap_data);
2135 save_pcap_data = pm->pcap_data;
2137 memset (pm, 0, sizeof (*pm));
2139 pm->pcap_data = save_pcap_data;
2141 vec_validate_aligned (vnet_trace_placeholder, 2048,
2142 CLIB_CACHE_LINE_BYTES);
2144 clib_spinlock_init (&(pm->lock));
2146 if (a->filename == 0)
2151 stem = format (stem, "rx");
2153 stem = format (stem, "tx");
2155 stem = format (stem, "drop");
2156 a->filename = format (0, "/tmp/%v.pcap%c", stem, 0);
2160 pm->file_name = (char *) a->filename;
2161 pm->n_packets_captured = 0;
2162 pm->packet_type = PCAP_PACKET_TYPE_ethernet;
2163 /* Preallocate the data vector? */
2164 if (a->preallocate_data)
2167 (pm->pcap_data, a->packets_to_capture
2168 * ((sizeof (pcap_packet_header_t) + a->max_bytes_per_pkt)));
2169 vec_reset_length (pm->pcap_data);
2171 pm->n_packets_to_capture = a->packets_to_capture;
2172 pp->pcap_sw_if_index = a->sw_if_index;
2174 pp->filter_classify_table_index =
2175 cm->classify_table_index_by_sw_if_index[0];
2177 pp->filter_classify_table_index = ~0;
2178 pp->pcap_error_index = a->drop_err;
2179 pp->pcap_rx_enable = a->rx_enable;
2180 pp->pcap_tx_enable = a->tx_enable;
2181 pp->pcap_drop_enable = a->drop_enable;
2182 pp->max_bytes_per_pkt = a->max_bytes_per_pkt;
2186 pp->pcap_rx_enable = 0;
2187 pp->pcap_tx_enable = 0;
2188 pp->pcap_drop_enable = 0;
2189 pp->filter_classify_table_index = ~0;
2190 pp->pcap_error_index = ~0;
2191 if (pm->n_packets_captured)
2193 clib_error_t *error;
2194 pm->n_packets_to_capture = pm->n_packets_captured;
2195 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2196 pm->n_packets_captured, pm->file_name);
2197 error = pcap_write (pm);
2198 if (pm->flags & PCAP_MAIN_INIT_DONE)
2200 /* Report I/O errors... */
2203 clib_error_report (error);
2204 return VNET_API_ERROR_SYSCALL_ERROR_1;
2206 vec_free (pm->file_name);
2208 vec_free (pm->pcap_data);
2212 return VNET_API_ERROR_NO_SUCH_ENTRY;
2218 static clib_error_t *
2219 pcap_trace_command_fn (vlib_main_t * vm,
2220 unformat_input_t * input, vlib_cli_command_t * cmd)
2222 unformat_input_t _line_input, *line_input = &_line_input;
2223 vnet_pcap_dispatch_trace_args_t _a, *a = &_a;
2224 vnet_main_t *vnm = vnet_get_main ();
2227 u32 max_bytes_per_pkt = 512;
2231 int preallocate_data = 0;
2232 int drop_enable = 0;
2236 u32 sw_if_index = 0; /* default: any interface */
2237 vlib_error_t drop_err = ~0; /* default: any error */
2239 /* Get a line of input. */
2240 if (!unformat_user (input, unformat_line_input, line_input))
2243 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2245 if (unformat (line_input, "rx"))
2247 else if (unformat (line_input, "tx"))
2249 else if (unformat (line_input, "drop"))
2251 else if (unformat (line_input, "off"))
2252 rx_enable = tx_enable = drop_enable = 0;
2253 else if (unformat (line_input, "max-bytes-per-pkt %u",
2254 &max_bytes_per_pkt))
2256 else if (unformat (line_input, "max %d", &max))
2258 else if (unformat (line_input, "packets-to-capture %d", &max))
2260 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2263 else if (unformat (line_input, "status %=", &status, 1))
2265 else if (unformat (line_input, "intfc %U",
2266 unformat_vnet_sw_interface, vnm, &sw_if_index))
2268 else if (unformat (line_input, "interface %U",
2269 unformat_vnet_sw_interface, vnm, &sw_if_index))
2271 else if (unformat (line_input, "error %U", unformat_vlib_error, vm,
2274 else if (unformat (line_input, "preallocate-data %=",
2275 &preallocate_data, 1))
2277 else if (unformat (line_input, "free-data %=", &free_data, 1))
2279 else if (unformat (line_input, "intfc any")
2280 || unformat (line_input, "interface any"))
2282 else if (unformat (line_input, "filter"))
2286 return clib_error_return (0, "unknown input `%U'",
2287 format_unformat_error, line_input);
2291 unformat_free (line_input);
2293 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2294 a->filename = filename;
2295 a->rx_enable = rx_enable;
2296 a->tx_enable = tx_enable;
2297 a->preallocate_data = preallocate_data;
2298 a->free_data = free_data;
2299 a->drop_enable = drop_enable;
2301 a->packets_to_capture = max;
2302 a->sw_if_index = sw_if_index;
2304 a->max_bytes_per_pkt = max_bytes_per_pkt;
2305 a->drop_err = drop_err;
2307 rv = vnet_pcap_dispatch_trace_configure (a);
2314 case VNET_API_ERROR_INVALID_VALUE:
2315 return clib_error_return (0, "dispatch trace already enabled...");
2317 case VNET_API_ERROR_VALUE_EXIST:
2318 return clib_error_return (0, "dispatch trace already disabled...");
2320 case VNET_API_ERROR_INVALID_VALUE_2:
2321 return clib_error_return
2322 (0, "can't change number of records to capture while tracing...");
2324 case VNET_API_ERROR_SYSCALL_ERROR_1:
2325 return clib_error_return (0, "I/O writing trace capture...");
2327 case VNET_API_ERROR_NO_SUCH_ENTRY:
2328 return clib_error_return (0, "No packets captured...");
2330 case VNET_API_ERROR_INVALID_MEMORY_SIZE:
2331 return clib_error_return (0,
2332 "Max bytes per pkt must be > 32, < 9000...");
2334 case VNET_API_ERROR_NO_SUCH_LABEL:
2335 return clib_error_return
2336 (0, "No classify filter configured, see 'classify filter...'");
2339 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2346 * This command is used to start or stop a packet capture, or show
2347 * the status of packet capture.
2349 * This command has the following optional parameters:
2352 * - <b>rx</b> - Capture received packets
2354 * - <b>tx</b> - Capture transmitted packets
2356 * - <b>drop</b> - Capture dropped packets
2358 * - <b>off</b> - Stop capturing packets, write results to the specified file
2360 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2361 * of packets have been received, buffer is flushed to file. Once another
2362 * '<em>nn</em>' number of packets have been received, buffer is flushed
2363 * to file, overwriting previous write. If not entered, value defaults
2364 * to 100. Can only be updated if packet capture is off.
2366 * - <b>max-bytes-per-pkt <nnnn></b> - Maximum number of bytes to capture
2367 * for each packet. Must be >= 32, <= 9000.
2369 * - <b>preallocate-data</b> - Preallocate the data buffer, to avoid
2370 * vector expansion delays during pcap capture
2372 * - <b>free-data</b> - Free the data buffer. Ordinarily it's a feature
2373 * to retain the data buffer so this option is seldom used.
2375 * - <b>intfc <interface-name>|any</b> - Used to specify a given interface,
2376 * or use '<em>any</em>' to run packet capture on all interfaces.
2377 * '<em>any</em>' is the default if not provided. Settings from a previous
2378 * packet capture are preserved, so '<em>any</em>' can be used to reset
2379 * the interface setting.
2381 * - <b>filter</b> - Use the pcap rx / tx / drop trace filter, which
2382 * must be configured. Use <b>classify filter pcap...</b> to configure the
2383 * filter. The filter will only be executed if the per-interface or
2384 * any-interface tests fail.
2386 * - <b>error <node>.<error></b> - filter packets based on a specific error.
2387 * For example: error {ip4-udp-lookup}.{No listener for dst port}
2389 * - <b>file <name></b> - Used to specify the output filename. The file will
2390 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2391 * supported. Directory should not be entered. If file already exists, file
2392 * will be overwritten. If no filename is provided, the file will be
2393 * named "/tmp/rx.pcap", "/tmp/tx.pcap", "/tmp/rxandtx.pcap", etc.
2394 * Can only be updated if packet capture is off.
2396 * - <b>status</b> - Displays the current status and configured attributes
2397 * associated with a packet capture. If packet capture is in progress,
2398 * '<em>status</em>' also will return the number of packets currently in
2399 * the local buffer. All additional attributes entered on command line
2400 * with '<em>status</em>' will be ignored and not applied.
2403 * Example of how to display the status of a tx packet capture when off:
2404 * @cliexstart{pcap trace status}
2405 * max is 100, for any interface to file /tmp/vpe.pcap
2406 * pcap tx capture is off...
2408 * Example of how to start a tx packet capture:
2409 * @cliexstart{pcap trace tx max 35 intfc GigabitEthernet0/8/0 file
2412 * Example of how to display the status of a tx packet capture in progress:
2413 * @cliexstart{pcap trace status}
2414 * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
2415 * pcap tx capture is on: 20 of 35 pkts...
2417 * Example of how to stop a tx packet capture:
2418 * @cliexstart{pcap trace off}
2419 * captured 21 pkts...
2420 * saved to /tmp/vppTest.pcap...
2425 VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
2426 .path = "pcap trace",
2428 "pcap trace [rx] [tx] [drop] [off] [max <nn>] [intfc <interface>|any]\n"
2429 " [file <name>] [status] [max-bytes-per-pkt <nnnn>][filter]\n"
2430 " [preallocate-data][free-data]",
2431 .function = pcap_trace_command_fn,
2435 static clib_error_t *
2436 set_interface_name (vlib_main_t *vm, unformat_input_t *input,
2437 vlib_cli_command_t *cmd)
2439 clib_error_t *error = 0;
2440 unformat_input_t _line_input, *line_input = &_line_input;
2441 vnet_main_t *vnm = vnet_get_main ();
2442 u32 hw_if_index = ~0;
2445 if (!unformat_user (input, unformat_line_input, line_input))
2448 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2450 if (unformat (line_input, "%U %s", unformat_vnet_hw_interface, vnm,
2451 &hw_if_index, &name))
2455 error = clib_error_return (0, "parse error: '%U'",
2456 format_unformat_error, line_input);
2457 unformat_free (line_input);
2463 unformat_free (line_input);
2465 if (hw_if_index == (u32) ~0 || name == 0)
2468 error = clib_error_return (0, "please specify valid interface name");
2472 error = vnet_rename_interface (vnm, hw_if_index, name);
2478 VLIB_CLI_COMMAND (cmd_set_if_name, static) = {
2479 .path = "set interface name",
2480 .short_help = "set interface name <interface-name> <new-interface-name>",
2481 .function = set_interface_name,
2485 static clib_error_t *
2486 set_interface_tx_hash_cmd (vlib_main_t *vm, unformat_input_t *input,
2487 vlib_cli_command_t *cmd)
2489 clib_error_t *error = 0;
2490 unformat_input_t _line_input, *line_input = &_line_input;
2491 vnet_main_t *vnm = vnet_get_main ();
2492 vnet_hw_interface_t *hi;
2494 u32 hw_if_index = (u32) ~0;
2496 vnet_hash_fn_type_t ftype;
2498 if (!unformat_user (input, unformat_line_input, line_input))
2501 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2503 if (unformat (line_input, "%U", unformat_vnet_hw_interface, vnm,
2506 else if (unformat (line_input, "hash-name %s", &hash_name))
2510 error = clib_error_return (0, "parse error: '%U'",
2511 format_unformat_error, line_input);
2512 unformat_free (line_input);
2517 unformat_free (line_input);
2519 if (hw_if_index == (u32) ~0)
2521 error = clib_error_return (0, "please specify valid interface name");
2525 hi = vnet_get_hw_interface (vnm, hw_if_index);
2527 vnet_get_hw_interface_class (vnm, hi->hw_class_index)->tx_hash_fn_type;
2528 hf = vnet_hash_function_from_name ((const char *) hash_name, ftype);
2532 error = clib_error_return (0, "please specify valid hash name");
2538 vec_free (hash_name);
2542 VLIB_CLI_COMMAND (cmd_set_if_tx_hash, static) = {
2543 .path = "set interface tx-hash",
2544 .short_help = "set interface tx-hash <interface> hash-name <hash-name>",
2545 .function = set_interface_tx_hash_cmd,
2548 static clib_error_t *
2549 show_tx_hash (vlib_main_t *vm, unformat_input_t *input,
2550 vlib_cli_command_t *cmd)
2552 clib_error_t *error = 0;
2553 unformat_input_t _line_input, *line_input = &_line_input;
2554 vnet_main_t *vnm = vnet_get_main ();
2555 vnet_hw_interface_t *hi;
2556 vnet_hash_function_registration_t *hash;
2557 u32 hw_if_index = (u32) ~0;
2558 vnet_hash_fn_type_t ftype;
2560 if (!unformat_user (input, unformat_line_input, line_input))
2563 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2565 if (unformat (line_input, "%U", unformat_vnet_hw_interface, vnm,
2570 error = clib_error_return (0, "parse error: '%U'",
2571 format_unformat_error, line_input);
2572 unformat_free (line_input);
2577 unformat_free (line_input);
2579 if (hw_if_index == (u32) ~0)
2581 error = clib_error_return (0, "please specify valid interface name");
2585 hi = vnet_get_hw_interface (vnm, hw_if_index);
2587 vnet_get_hw_interface_class (vnm, hi->hw_class_index)->tx_hash_fn_type;
2591 hash = vnet_hash_function_from_func (hi->hf, ftype);
2593 vlib_cli_output (vm, "%U", format_vnet_hash, hash);
2595 vlib_cli_output (vm, "no matching hash function found");
2598 vlib_cli_output (vm, "no hashing function set");
2604 VLIB_CLI_COMMAND (cmd_show_tx_hash, static) = {
2605 .path = "show interface tx-hash",
2606 .short_help = "show interface tx-hash [interface]",
2607 .function = show_tx_hash,
2611 * fd.io coding-style-patch-verification: ON
2614 * eval: (c-set-style "gnu")