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.
42 * @brief Interface CLI.
44 * Source code for several CLI interface commands.
48 #include <vnet/vnet.h>
49 #include <vnet/ip/ip.h>
50 #include <vppinfra/bitmap.h>
51 #include <vnet/fib/ip4_fib.h>
52 #include <vnet/fib/ip6_fib.h>
53 #include <vnet/l2/l2_output.h>
54 #include <vnet/l2/l2_input.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)
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, is_show, show_bond = 0;
77 is_show = strstr (cmd->path, "show") != 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);
172 * Display more detailed information about all or a list of given interfaces.
173 * The verboseness of the output can be controlled by the following optional
175 * - brief: Only show name, index and state (default for bonded interfaces).
176 * - verbose: Also display additional attributes (default for all other interfaces).
177 * - detail: Also display all remaining attributes and extended statistics.
179 * To limit the output of the command to bonded interfaces and their slave
180 * interfaces, use the '<em>bond</em>' optional parameter.
183 * Example of how to display default data for all interfaces:
184 * @cliexstart{show hardware-interfaces}
185 * Name Idx Link Hardware
186 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
187 * Ethernet address ec:f4:bb:c0:bc:fc
189 * carrier up full duplex speed 1000 mtu 9216
190 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
192 * GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
193 * Ethernet address ec:f4:bb:c0:bc:fd
195 * carrier up full duplex speed 1000 mtu 9216
196 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
198 * VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
199 * Ethernet address 02:fe:a5:a9:8b:8e
200 * VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
201 * Ethernet address 02:fe:c0:4e:3b:b0
202 * VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
203 * Ethernet address 02:fe:1f:73:92:81
204 * VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
205 * Ethernet address 02:fe:f2:25:c4:68
206 * local0 0 down local0
209 * Example of how to display '<em>verbose</em>' data for an interface by name and
210 * software index (where 2 is the software index):
211 * @cliexstart{show hardware-interfaces GigabitEthernet7/0/0 2 verbose}
212 * Name Idx Link Hardware
213 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
214 * Ethernet address ec:f4:bb:c0:bc:fc
216 * carrier up full duplex speed 1000 mtu 9216
217 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
219 * GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
220 * Ethernet address ec:f4:bb:c0:bc:fd
222 * carrier up full duplex speed 1000 mtu 9216
223 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
228 VLIB_CLI_COMMAND (show_hw_interfaces_command, static) = {
229 .path = "show hardware-interfaces",
230 .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] "
231 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
232 .function = show_or_clear_hw_interfaces,
238 * Clear the extended statistics for all or a list of given interfaces
239 * (statistics associated with the '<em>show hardware-interfaces</em>' command).
242 * Example of how to clear the extended statistics for all interfaces:
243 * @cliexcmd{clear hardware-interfaces}
244 * Example of how to clear the extended statistics for an interface by
245 * name and software index (where 2 is the software index):
246 * @cliexcmd{clear hardware-interfaces GigabitEthernet7/0/0 2}
249 VLIB_CLI_COMMAND (clear_hw_interface_counters_command, static) = {
250 .path = "clear hardware-interfaces",
251 .short_help = "clear hardware-interfaces "
252 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
253 .function = show_or_clear_hw_interfaces,
258 sw_interface_name_compare (void *a1, void *a2)
260 vnet_sw_interface_t *si1 = a1;
261 vnet_sw_interface_t *si2 = a2;
263 return vnet_sw_interface_compare (vnet_get_main (),
264 si1->sw_if_index, si2->sw_if_index);
267 static clib_error_t *
268 show_sw_interfaces (vlib_main_t * vm,
269 unformat_input_t * input, vlib_cli_command_t * cmd)
271 clib_error_t *error = 0;
272 vnet_main_t *vnm = vnet_get_main ();
273 unformat_input_t _linput, *linput = &_linput;
274 vnet_interface_main_t *im = &vnm->interface_main;
275 vnet_sw_interface_t *si, *sorted_sis = 0;
276 u32 sw_if_index = ~(u32) 0;
277 u8 show_addresses = 0;
278 u8 show_features = 0;
283 * Get a line of input. Won't work if the user typed
284 * "show interface" and nothing more.
286 if (unformat_user (input, unformat_line_input, linput))
288 while (unformat_check_input (linput) != UNFORMAT_END_OF_INPUT)
290 /* See if user wants to show specific interface */
292 (linput, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
294 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
295 vec_add1 (sorted_sis, si[0]);
297 else if (unformat (linput, "address") || unformat (linput, "addr"))
299 else if (unformat (linput, "features") || unformat (linput, "feat"))
301 else if (unformat (linput, "tag"))
303 else if (unformat (linput, "verbose"))
307 vec_free (sorted_sis);
308 error = clib_error_return (0, "unknown input `%U'",
309 format_unformat_error, linput);
313 unformat_free (linput);
315 if (show_features || show_tag)
317 if (sw_if_index == ~(u32) 0)
319 vec_free (sorted_sis);
320 return clib_error_return (0, "Interface not specified...");
326 vnet_interface_features_show (vm, sw_if_index, verbose);
328 l2_input_config_t *l2_input = l2input_intf_config (sw_if_index);
329 u32 fb = l2_input->feature_bitmap;
330 /* intf input features are masked by bridge domain */
331 if (l2_input->bridge)
332 fb &= l2input_bd_config (l2_input->bd_index)->feature_bitmap;
333 vlib_cli_output (vm, "\nl2-input:\n%U", format_l2_input_features, fb,
336 l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
337 vlib_cli_output (vm, "\nl2-output:");
338 if (l2_output->out_vtr_flag)
339 vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
340 vlib_cli_output (vm, "%U", format_l2_output_features,
341 l2_output->feature_bitmap, 1);
342 vec_free (sorted_sis);
348 tag = vnet_get_sw_interface_tag (vnm, sw_if_index);
349 vlib_cli_output (vm, "%U: %s",
350 format_vnet_sw_if_index_name, vnm, sw_if_index,
351 tag ? (char *) tag : "(none)");
352 vec_free (sorted_sis);
357 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, 0);
359 if (vec_len (sorted_sis) == 0) /* Get all interfaces */
361 /* Gather interfaces. */
363 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
364 _vec_len (sorted_sis) = 0;
366 pool_foreach (si, im->sw_interfaces,
368 int visible = vnet_swif_is_api_visible (si);
370 vec_add1 (sorted_sis, si[0]);}
374 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
379 vec_foreach (si, sorted_sis)
381 ip4_main_t *im4 = &ip4_main;
382 ip6_main_t *im6 = &ip6_main;
383 ip_lookup_main_t *lm4 = &im4->lookup_main;
384 ip_lookup_main_t *lm6 = &im6->lookup_main;
385 ip_interface_address_t *ia = 0;
386 u32 fib_index4 = 0, fib_index6 = 0;
388 if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
389 fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
392 if (vec_len (im6->fib_index_by_sw_if_index) > si->sw_if_index)
393 fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
396 ip4_fib_t *fib4 = ip4_fib_get (fib_index4);
397 ip6_fib_t *fib6 = ip6_fib_get (fib_index6);
399 if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
401 (vm, "%U (%s): \n unnumbered, use %U",
402 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
403 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
404 format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
408 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
409 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn");
411 /* Display any L2 info */
412 l2_input_config_t *l2_input = l2input_intf_config (si->sw_if_index);
413 if (l2_input->bridge)
415 bd_main_t *bdm = &bd_main;
416 u32 bd_id = l2input_main.bd_configs[l2_input->bd_index].bd_id;
417 vlib_cli_output (vm, " L2 bridge bd-id %d idx %d shg %d %s",
418 bd_id, bd_find_index (bdm, bd_id), l2_input->shg,
419 l2_input->bvi ? "bvi" : " ");
421 else if (l2_input->xconnect)
422 vlib_cli_output (vm, " L2 xconnect %U",
423 format_vnet_sw_if_index_name, vnm,
424 l2_input->output_sw_if_index);
427 /* Display any IP4 addressing info */
428 foreach_ip_interface_address (lm4, ia, si->sw_if_index,
429 1 /* honor unnumbered */,
431 ip4_address_t *r4 = ip_interface_address_get_address (lm4, ia);
433 vlib_cli_output (vm, " L3 %U/%d ip4 table-id %d fib-idx %d",
434 format_ip4_address, r4, ia->address_length,
436 ip4_fib_index_from_table_id (fib4->table_id));
438 vlib_cli_output (vm, " L3 %U/%d",
439 format_ip4_address, r4, ia->address_length);
444 /* Display any IP6 addressing info */
445 foreach_ip_interface_address (lm6, ia, si->sw_if_index,
446 1 /* honor unnumbered */,
448 ip6_address_t *r6 = ip_interface_address_get_address (lm6, ia);
450 vlib_cli_output (vm, " L3 %U/%d ip6 table-id %d fib-idx %d",
451 format_ip6_address, r6, ia->address_length,
453 ip6_fib_index_from_table_id (fib6->table_id));
455 vlib_cli_output (vm, " L3 %U/%d",
456 format_ip6_address, r6, ia->address_length);
463 vec_foreach (si, sorted_sis)
465 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, si);
470 vec_free (sorted_sis);
475 VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
476 .path = "show interface",
477 .short_help = "show interface [address|addr|features|feat] [<interface> [<interface> [..]]] [verbose]",
478 .function = show_sw_interfaces,
483 /* Root of all interface commands. */
485 VLIB_CLI_COMMAND (vnet_cli_interface_command, static) = {
487 .short_help = "Interface commands",
492 VLIB_CLI_COMMAND (vnet_cli_set_interface_command, static) = {
493 .path = "set interface",
494 .short_help = "Interface commands",
498 static clib_error_t *
499 clear_interface_counters (vlib_main_t * vm,
500 unformat_input_t * input, vlib_cli_command_t * cmd)
502 vnet_main_t *vnm = vnet_get_main ();
503 vnet_interface_main_t *im = &vnm->interface_main;
504 vlib_simple_counter_main_t *sm;
505 vlib_combined_counter_main_t *cm;
508 n_counters = vec_len (im->combined_sw_if_counters);
510 for (j = 0; j < n_counters; j++)
512 im = &vnm->interface_main;
513 cm = im->combined_sw_if_counters + j;
514 vlib_clear_combined_counters (cm);
517 n_counters = vec_len (im->sw_if_counters);
519 for (j = 0; j < n_counters; j++)
521 im = &vnm->interface_main;
522 sm = im->sw_if_counters + j;
523 vlib_clear_simple_counters (sm);
530 * Clear the statistics for all interfaces (statistics associated with the
531 * '<em>show interface</em>' command).
534 * Example of how to clear the statistics for all interfaces:
535 * @cliexcmd{clear interfaces}
538 VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
539 .path = "clear interfaces",
540 .short_help = "clear interfaces",
541 .function = clear_interface_counters,
546 * Parse subinterface names.
548 * The following subinterface syntax is supported. The first two are for
549 * backwards compatability:
552 * - a subinterface with the name <intf-name>.<id>. The subinterface
553 * is a single dot1q vlan with vlan id <id> and exact-match semantics.
555 * <intf-name> <min_id>-<max_id>
556 * - a set of the above subinterfaces, repeating for each id
557 * in the range <min_id> to <max_id>
559 * In the following, exact-match semantics (i.e. the number of vlan tags on the
560 * packet must match the number of tags in the configuration) are used only if
561 * the keyword exact-match is present. Non-exact match is the default.
563 * <intf-name> <id> dot1q <outer_id> [exact-match]
564 * - a subinterface with the name <intf-name>.<id>. The subinterface
565 * is a single dot1q vlan with vlan id <outer_id>.
567 * <intf-name> <id> dot1q any [exact-match]
568 * - a subinterface with the name <intf-name>.<id>. The subinterface
569 * is a single dot1q vlan with any vlan id.
571 * <intf-name> <id> dot1q <outer_id> inner-dot1q <inner_id> [exact-match]
572 * - a subinterface with the name <intf-name>.<id>. The subinterface
573 * is a double dot1q vlan with outer vlan id <outer_id> and inner vlan id
576 * <intf-name> <id> dot1q <outer_id> inner-dot1q any [exact-match]
577 * - a subinterface with the name <intf-name>.<id>. The subinterface
578 * is a double dot1q vlan with outer vlan id <id> and any inner vlan id.
580 * <intf-name> <id> dot1q any inner-dot1q any [exact-match]
582 * - a subinterface with the name <intf-name>.<id>. The subinterface
583 * is a double dot1q vlan with any outer vlan id and any inner vlan id.
585 * For each of the above CLI, there is a duplicate that uses the keyword
586 * "dot1ad" in place of the first "dot1q". These interfaces use ethertype
587 * 0x88ad in place of 0x8100 for the outer ethertype. Note that for double-
588 * tagged packets the inner ethertype is always 0x8100. Also note that
589 * the dot1q and dot1ad naming spaces are independent, so it is legal to
590 * have both "Gig3/0/0.1 dot1q 100" and "Gig3/0/0.2 dot1ad 100". For example:
592 * <intf-name> <id> dot1ad <outer_id> inner-dot1q <inner_id> [exact-match]
593 * - a subinterface with the name <intf-name>.<id>. The subinterface
594 * is a double dot1ad vlan with outer vlan id <outer_id> and inner vlan
597 * <intf-name> <id> untagged
598 * - a subinterface with the name <intf-name>.<id>. The subinterface
599 * has no vlan tags. Only one can be specified per interface.
601 * <intf-name> <id> default
602 * - a subinterface with the name <intf-name>.<id>. This is associated
603 * with a packet that did not match any other configured subinterface
604 * on this interface. Only one can be specified per interface.
607 static clib_error_t *
608 parse_vlan_sub_interfaces (unformat_input_t * input,
609 vnet_sw_interface_t * template)
611 clib_error_t *error = 0;
612 u32 inner_vlan, outer_vlan;
614 if (unformat (input, "any inner-dot1q any"))
616 template->sub.eth.flags.two_tags = 1;
617 template->sub.eth.flags.outer_vlan_id_any = 1;
618 template->sub.eth.flags.inner_vlan_id_any = 1;
620 else if (unformat (input, "any"))
622 template->sub.eth.flags.one_tag = 1;
623 template->sub.eth.flags.outer_vlan_id_any = 1;
625 else if (unformat (input, "%d inner-dot1q any", &outer_vlan))
627 template->sub.eth.flags.two_tags = 1;
628 template->sub.eth.flags.inner_vlan_id_any = 1;
629 template->sub.eth.outer_vlan_id = outer_vlan;
631 else if (unformat (input, "%d inner-dot1q %d", &outer_vlan, &inner_vlan))
633 template->sub.eth.flags.two_tags = 1;
634 template->sub.eth.outer_vlan_id = outer_vlan;
635 template->sub.eth.inner_vlan_id = inner_vlan;
637 else if (unformat (input, "%d", &outer_vlan))
639 template->sub.eth.flags.one_tag = 1;
640 template->sub.eth.outer_vlan_id = outer_vlan;
644 error = clib_error_return (0, "expected dot1q config, got `%U'",
645 format_unformat_error, input);
649 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
651 if (unformat (input, "exact-match"))
653 template->sub.eth.flags.exact_match = 1;
661 static clib_error_t *
662 create_sub_interfaces (vlib_main_t * vm,
663 unformat_input_t * input, vlib_cli_command_t * cmd)
665 vnet_main_t *vnm = vnet_get_main ();
666 clib_error_t *error = 0;
667 u32 hw_if_index, sw_if_index;
668 vnet_hw_interface_t *hi;
669 u32 id, id_min, id_max;
670 vnet_sw_interface_t template;
673 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
675 error = clib_error_return (0, "unknown interface `%U'",
676 format_unformat_error, input);
680 clib_memset (&template, 0, sizeof (template));
681 template.sub.eth.raw_flags = 0;
683 if (unformat (input, "%d default", &id_min))
686 template.sub.eth.flags.default_sub = 1;
688 else if (unformat (input, "%d untagged", &id_min))
691 template.sub.eth.flags.no_tags = 1;
692 template.sub.eth.flags.exact_match = 1;
694 else if (unformat (input, "%d dot1q", &id_min))
696 /* parse dot1q config */
698 error = parse_vlan_sub_interfaces (input, &template);
702 else if (unformat (input, "%d dot1ad", &id_min))
704 /* parse dot1ad config */
706 template.sub.eth.flags.dot1ad = 1;
707 error = parse_vlan_sub_interfaces (input, &template);
711 else if (unformat (input, "%d-%d", &id_min, &id_max))
713 template.sub.eth.flags.one_tag = 1;
714 template.sub.eth.flags.exact_match = 1;
718 else if (unformat (input, "%d", &id_min))
721 template.sub.eth.flags.one_tag = 1;
722 template.sub.eth.outer_vlan_id = id_min;
723 template.sub.eth.flags.exact_match = 1;
728 error = clib_error_return (0, "expected ID or ID MIN-MAX, got `%U'",
729 format_unformat_error, input);
733 hi = vnet_get_hw_interface (vnm, hw_if_index);
735 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
738 clib_error_return (0,
739 "not allowed as %v belong to a BondEthernet interface",
744 for (id = id_min; id <= id_max; id++)
747 vnet_interface_main_t *im = &vnm->interface_main;
748 u64 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
751 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
755 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
756 hi->sw_if_index, id);
760 kp = clib_mem_alloc (sizeof (*kp));
761 *kp = sup_and_sub_key;
763 template.type = VNET_SW_INTERFACE_TYPE_SUB;
764 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
765 template.sup_sw_if_index = hi->sw_if_index;
766 template.sub.id = id;
768 template.sub.eth.outer_vlan_id = id;
770 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
774 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
775 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
776 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
777 vnet_get_main (), sw_if_index);
785 * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
786 * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
787 * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
788 * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
789 * but this is not recommended.
791 * This command has several variations:
792 * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
793 * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
795 * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
796 * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
797 * match any other subinterfaces should be sent to this subinterface.
799 * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
800 * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
801 * to this subinterface.
803 * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
804 * subinterfaces to handle a range of VLAN IDs.
806 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
807 * Use this command to specify the outer VLAN ID, to either be explicit or to make the
808 * VLAN ID different from the '<em>subId</em>'.
810 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
811 * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
814 * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explicitly entered, subinterfaces
815 * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
816 * default. If '<em>exact-match</em>' is specified, packets must have the same number of
817 * VLAN tags as the configuration. For non-exact-match, packets must at least that number
818 * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
819 * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
820 * entered, then the default behavior is exact-match.
822 * Use the '<em>show interface</em>' command to display all subinterfaces.
826 * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
827 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
829 * The previous example is shorthand and is equivalent to:
830 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
833 * Example of how to create a subinterface number that is different from the VLAN ID:
834 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
837 * Examples of how to create q-in-q and q-in-any subinterfaces:
838 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
839 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
841 * Examples of how to create dot1ad interfaces:
842 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
843 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
846 * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
847 * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
848 * is non-exact match:
849 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
851 * However, the same packet would NOT match this interface because '<em>exact-match</em>'
852 * is specified and only one VLAN is configured, but packet contains two VLANs:
853 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
856 * Example of how to created a subinterface to process untagged packets:
857 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
859 * Example of how to created a subinterface to process any packet with a VLAN ID that
860 * does not match any other subinterface:
861 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
863 * When subinterfaces are created, they are in the down state. Example of how to
864 * enable a newly created subinterface:
865 * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
869 VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
870 .path = "create sub-interfaces",
871 .short_help = "create sub-interfaces <interface> "
872 "{<subId> [default|untagged]} | "
873 "{<subId>-<subId>} | "
874 "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
875 .function = create_sub_interfaces,
879 static clib_error_t *
880 set_state (vlib_main_t * vm,
881 unformat_input_t * input, vlib_cli_command_t * cmd)
883 vnet_main_t *vnm = vnet_get_main ();
885 u32 sw_if_index, flags;
888 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
890 error = clib_error_return (0, "unknown interface `%U'",
891 format_unformat_error, input);
895 if (!unformat (input, "%U", unformat_vnet_sw_interface_flags, &flags))
897 error = clib_error_return (0, "unknown flags `%U'",
898 format_unformat_error, input);
902 error = vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
912 * This command is used to change the admin state (up/down) of an interface.
914 * If an interface is down, the optional '<em>punt</em>' flag can also be set.
915 * The '<em>punt</em>' flag implies the interface is disabled for forwarding
916 * but punt all traffic to slow-path. Use the '<em>enable</em>' flag to clear
917 * '<em>punt</em>' flag (interface is still down).
920 * Example of how to configure the admin state of an interface to '<em>up</em?':
921 * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
922 * Example of how to configure the admin state of an interface to '<em>down</em?':
923 * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
926 VLIB_CLI_COMMAND (set_state_command, static) = {
927 .path = "set interface state",
928 .short_help = "set interface state <interface> [up|down|punt|enable]",
929 .function = set_state,
933 static clib_error_t *
934 set_unnumbered (vlib_main_t * vm,
935 unformat_input_t * input, vlib_cli_command_t * cmd)
937 vnet_main_t *vnm = vnet_get_main ();
938 u32 unnumbered_sw_if_index = ~0;
939 u32 inherit_from_sw_if_index = ~0;
942 if (unformat (input, "%U use %U",
943 unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
944 unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
946 else if (unformat (input, "del %U",
947 unformat_vnet_sw_interface, vnm,
948 &unnumbered_sw_if_index))
951 return clib_error_return (0, "parse error '%U'",
952 format_unformat_error, input);
954 if (~0 == unnumbered_sw_if_index)
955 return clib_error_return (0, "Specify the unnumbered interface");
956 if (enable && ~0 == inherit_from_sw_if_index)
957 return clib_error_return (0, "When enabling unnumbered specify the"
958 " IP enabled interface that it uses");
960 vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
961 inherit_from_sw_if_index, enable);
967 VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
968 .path = "set interface unnumbered",
969 .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
970 .function = set_unnumbered,
976 static clib_error_t *
977 set_hw_class (vlib_main_t * vm,
978 unformat_input_t * input, vlib_cli_command_t * cmd)
980 vnet_main_t *vnm = vnet_get_main ();
981 vnet_interface_main_t *im = &vnm->interface_main;
983 u32 hw_if_index, hw_class_index;
986 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
988 error = clib_error_return (0, "unknown hardware interface `%U'",
989 format_unformat_error, input);
993 if (!unformat_user (input, unformat_hash_string,
994 im->hw_interface_class_by_name, &hw_class_index))
996 error = clib_error_return (0, "unknown hardware class `%U'",
997 format_unformat_error, input);
1001 error = vnet_hw_interface_set_class (vnm, hw_if_index, hw_class_index);
1010 VLIB_CLI_COMMAND (set_hw_class_command, static) = {
1011 .path = "set interface hw-class",
1012 .short_help = "Set interface hardware class",
1013 .function = set_hw_class,
1017 static clib_error_t *
1018 vnet_interface_cli_init (vlib_main_t * vm)
1023 VLIB_INIT_FUNCTION (vnet_interface_cli_init);
1025 static clib_error_t *
1026 renumber_interface_command_fn (vlib_main_t * vm,
1027 unformat_input_t * input,
1028 vlib_cli_command_t * cmd)
1031 u32 new_dev_instance;
1032 vnet_main_t *vnm = vnet_get_main ();
1035 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1036 return clib_error_return (0, "unknown hardware interface `%U'",
1037 format_unformat_error, input);
1039 if (!unformat (input, "%d", &new_dev_instance))
1040 return clib_error_return (0, "new dev instance missing");
1042 rv = vnet_interface_name_renumber (hw_if_index, new_dev_instance);
1050 return clib_error_return (0, "vnet_interface_name_renumber returned %d",
1060 VLIB_CLI_COMMAND (renumber_interface_command, static) = {
1061 .path = "renumber interface",
1062 .short_help = "renumber interface <interface> <new-dev-instance>",
1063 .function = renumber_interface_command_fn,
1067 static clib_error_t *
1068 promiscuous_cmd (vlib_main_t * vm,
1069 unformat_input_t * input, vlib_cli_command_t * cmd)
1071 vnet_main_t *vnm = vnet_get_main ();
1073 u32 flags = ETHERNET_INTERFACE_FLAG_ACCEPT_ALL;
1074 ethernet_main_t *em = ðernet_main;
1075 ethernet_interface_t *eif;
1077 if (unformat (input, "on %U",
1078 unformat_vnet_hw_interface, vnm, &hw_if_index))
1080 else if (unformat (input, "off %U",
1081 unformat_ethernet_interface, vnm, &hw_if_index))
1084 return clib_error_return (0, "unknown input `%U'",
1085 format_unformat_error, input);
1087 eif = ethernet_get_interface (em, hw_if_index);
1089 return clib_error_return (0, "not supported");
1091 ethernet_set_flags (vnm, hw_if_index, flags);
1096 VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
1097 .path = "set interface promiscuous",
1098 .short_help = "set interface promiscuous [on|off] <interface>",
1099 .function = promiscuous_cmd,
1103 static clib_error_t *
1104 mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1106 vnet_main_t *vnm = vnet_get_main ();
1107 u32 hw_if_index, sw_if_index, mtu;
1108 ethernet_main_t *em = ðernet_main;
1109 u32 mtus[VNET_N_MTU] = { 0, 0, 0, 0 };
1111 if (unformat (input, "%d %U", &mtu,
1112 unformat_vnet_hw_interface, vnm, &hw_if_index))
1115 * Change physical MTU on interface. Only supported for Ethernet
1118 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1119 ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
1122 return clib_error_return (0, "not supported");
1124 if (mtu < hi->min_supported_packet_bytes)
1125 return clib_error_return (0, "Invalid mtu (%d): "
1126 "must be >= min pkt bytes (%d)", mtu,
1127 hi->min_supported_packet_bytes);
1129 if (mtu > hi->max_supported_packet_bytes)
1130 return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
1131 hi->max_supported_packet_bytes);
1133 vnet_hw_interface_set_mtu (vnm, hw_if_index, mtu);
1136 else if (unformat (input, "packet %d %U", &mtu,
1137 unformat_vnet_sw_interface, vnm, &sw_if_index))
1138 /* Set default packet MTU (including L3 header */
1139 mtus[VNET_MTU_L3] = mtu;
1140 else if (unformat (input, "ip4 %d %U", &mtu,
1141 unformat_vnet_sw_interface, vnm, &sw_if_index))
1142 mtus[VNET_MTU_IP4] = mtu;
1143 else if (unformat (input, "ip6 %d %U", &mtu,
1144 unformat_vnet_sw_interface, vnm, &sw_if_index))
1145 mtus[VNET_MTU_IP6] = mtu;
1146 else if (unformat (input, "mpls %d %U", &mtu,
1147 unformat_vnet_sw_interface, vnm, &sw_if_index))
1148 mtus[VNET_MTU_MPLS] = mtu;
1150 return clib_error_return (0, "unknown input `%U'",
1151 format_unformat_error, input);
1153 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, mtus);
1160 VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
1161 .path = "set interface mtu",
1162 .short_help = "set interface mtu [packet|ip4|ip6|mpls] <value> <interface>",
1163 .function = mtu_cmd,
1167 static clib_error_t *
1168 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
1169 vlib_cli_command_t * cmd)
1171 vnet_main_t *vnm = vnet_get_main ();
1172 vnet_sw_interface_t *si = NULL;
1173 clib_error_t *error = 0;
1174 u32 sw_if_index = ~0;
1177 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1179 error = clib_error_return (0, "unknown interface `%U'",
1180 format_unformat_error, input);
1183 if (!unformat_user (input, unformat_ethernet_address, mac))
1185 error = clib_error_return (0, "expected mac address `%U'",
1186 format_unformat_error, input);
1189 si = vnet_get_sw_interface (vnm, sw_if_index);
1190 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
1196 * The '<em>set interface mac address </em>' command allows to set MAC address of given interface.
1197 * In case of NIC interfaces the one has to support MAC address change. A side effect of MAC address
1198 * change are changes of MAC addresses in FIB tables (ipv4 and ipv6).
1202 * Example of how to change MAC Address of interface:
1203 * @cliexcmd{set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01}
1204 * @cliexcmd{set interface mac address host-vpp0 aa:bb:cc:dd:ee:02}
1205 * @cliexcmd{set interface mac address tap-0 aa:bb:cc:dd:ee:03}
1206 * @cliexcmd{set interface mac address pg0 aa:bb:cc:dd:ee:04}
1210 VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
1211 .path = "set interface mac address",
1212 .short_help = "set interface mac address <interface> <mac-address>",
1213 .function = set_interface_mac_address,
1217 static clib_error_t *
1218 set_tag (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1220 vnet_main_t *vnm = vnet_get_main ();
1221 u32 sw_if_index = ~0;
1224 if (!unformat (input, "%U %s", unformat_vnet_sw_interface,
1225 vnm, &sw_if_index, &tag))
1226 return clib_error_return (0, "unknown input `%U'",
1227 format_unformat_error, input);
1229 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
1235 VLIB_CLI_COMMAND (set_tag_command, static) = {
1236 .path = "set interface tag",
1237 .short_help = "set interface tag <interface> <tag>",
1238 .function = set_tag,
1242 static clib_error_t *
1243 clear_tag (vlib_main_t * vm, unformat_input_t * input,
1244 vlib_cli_command_t * cmd)
1246 vnet_main_t *vnm = vnet_get_main ();
1247 u32 sw_if_index = ~0;
1249 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1250 return clib_error_return (0, "unknown input `%U'",
1251 format_unformat_error, input);
1253 vnet_clear_sw_interface_tag (vnm, sw_if_index);
1259 VLIB_CLI_COMMAND (clear_tag_command, static) = {
1260 .path = "clear interface tag",
1261 .short_help = "clear interface tag <interface>",
1262 .function = clear_tag,
1266 static clib_error_t *
1267 set_ip_directed_broadcast (vlib_main_t * vm,
1268 unformat_input_t * input, vlib_cli_command_t * cmd)
1270 vnet_main_t *vnm = vnet_get_main ();
1271 u32 sw_if_index = ~0;
1274 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index));
1275 else if (unformat (input, "enable"))
1277 else if (unformat (input, "disable"))
1280 return clib_error_return (0, "unknown input: `%U'",
1281 format_unformat_error, input);
1283 if (~0 == sw_if_index)
1284 return clib_error_return (0, "specify an interface: `%U'",
1285 format_unformat_error, input);
1287 vnet_sw_interface_ip_directed_broadcast (vnm, sw_if_index, enable);
1293 * This command is used to enable/disable IP directed broadcast
1294 * If directed broadcast is enabled a packet sent to the interface's
1295 * subnet broadcast address will be sent L2 broadcast on the interface,
1296 * otherwise it is dropped.
1299 VLIB_CLI_COMMAND (set_ip_directed_broadcast_command, static) = {
1300 .path = "set interface ip directed-broadcast",
1301 .short_help = "set interface enable <interface> <enable|disable>",
1302 .function = set_ip_directed_broadcast,
1306 static clib_error_t *
1307 set_hw_interface_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1308 u32 queue_id, vnet_hw_interface_rx_mode mode)
1310 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1311 vnet_device_class_t *dev_class =
1312 vnet_get_device_class (vnm, hw->dev_class_index);
1313 clib_error_t *error;
1314 vnet_hw_interface_rx_mode old_mode;
1317 if (mode == VNET_HW_INTERFACE_RX_MODE_DEFAULT)
1318 mode = hw->default_rx_mode;
1320 rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &old_mode);
1324 if (old_mode == mode)
1325 return 0; /* same rx-mode, no change */
1327 case VNET_API_ERROR_INVALID_INTERFACE:
1328 return clib_error_return (0, "invalid interface");
1329 case VNET_API_ERROR_INVALID_QUEUE:
1330 return clib_error_return (0, "invalid queue");
1332 return clib_error_return (0, "unknown error");
1335 if (dev_class->rx_mode_change_function)
1337 error = dev_class->rx_mode_change_function (vnm, hw_if_index, queue_id,
1343 rv = vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1348 case VNET_API_ERROR_UNSUPPORTED:
1349 return clib_error_return (0, "unsupported");
1350 case VNET_API_ERROR_INVALID_INTERFACE:
1351 return clib_error_return (0, "invalid interface");
1352 case VNET_API_ERROR_INVALID_QUEUE:
1353 return clib_error_return (0, "invalid queue");
1355 return clib_error_return (0, "unknown error");
1362 set_hw_interface_change_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1363 u8 queue_id_valid, u32 queue_id,
1364 vnet_hw_interface_rx_mode mode)
1366 clib_error_t *error = 0;
1367 vnet_hw_interface_t *hw;
1370 hw = vnet_get_hw_interface (vnm, hw_if_index);
1372 if (queue_id_valid == 0)
1374 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1376 error = set_hw_interface_rx_mode (vnm, hw_if_index, i, mode);
1380 hw->default_rx_mode = mode;
1383 error = set_hw_interface_rx_mode (vnm, hw_if_index, queue_id, mode);
1388 static clib_error_t *
1389 set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
1390 vlib_cli_command_t * cmd)
1392 clib_error_t *error = 0;
1393 unformat_input_t _line_input, *line_input = &_line_input;
1394 vnet_main_t *vnm = vnet_get_main ();
1395 u32 hw_if_index = (u32) ~ 0;
1396 u32 queue_id = (u32) ~ 0;
1397 vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
1398 u8 queue_id_valid = 0;
1400 if (!unformat_user (input, unformat_line_input, line_input))
1403 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1406 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1408 else if (unformat (line_input, "queue %d", &queue_id))
1410 else if (unformat (line_input, "polling"))
1411 mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
1412 else if (unformat (line_input, "interrupt"))
1413 mode = VNET_HW_INTERFACE_RX_MODE_INTERRUPT;
1414 else if (unformat (line_input, "adaptive"))
1415 mode = VNET_HW_INTERFACE_RX_MODE_ADAPTIVE;
1418 error = clib_error_return (0, "parse error: '%U'",
1419 format_unformat_error, line_input);
1420 unformat_free (line_input);
1425 unformat_free (line_input);
1427 if (hw_if_index == (u32) ~ 0)
1428 return clib_error_return (0, "please specify valid interface name");
1430 if (mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
1431 return clib_error_return (0, "please specify valid rx-mode");
1433 error = set_hw_interface_change_rx_mode (vnm, hw_if_index, queue_id_valid,
1440 * This command is used to assign the RX packet processing mode (polling,
1441 * interrupt, adaptive) of the a given interface, and optionally a
1442 * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
1443 * is applied to all queues of the interface. Not all interfaces support
1444 * all modes. To display the current rx-mode use the command
1445 * '<em>show interface rx-placement</em>'.
1448 * Example of how to assign rx-mode to all queues on an interface:
1449 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
1450 * Example of how to assign rx-mode to one queue of an interface:
1451 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
1452 * Example of how to display the rx-mode of all interfaces:
1453 * @cliexstart{show interface rx-placement}
1454 * Thread 1 (vpp_wk_0):
1456 * GigabitEthernet7/0/0 queue 0 (polling)
1457 * node vhost-user-input:
1458 * VirtualEthernet0/0/12 queue 0 (interrupt)
1459 * VirtualEthernet0/0/12 queue 2 (polling)
1460 * VirtualEthernet0/0/13 queue 0 (polling)
1461 * VirtualEthernet0/0/13 queue 2 (polling)
1462 * Thread 2 (vpp_wk_1):
1464 * GigabitEthernet7/0/1 queue 0 (polling)
1465 * node vhost-user-input:
1466 * VirtualEthernet0/0/12 queue 1 (polling)
1467 * VirtualEthernet0/0/12 queue 3 (polling)
1468 * VirtualEthernet0/0/13 queue 1 (polling)
1469 * VirtualEthernet0/0/13 queue 3 (polling)
1473 VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
1474 .path = "set interface rx-mode",
1475 .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
1476 .function = set_interface_rx_mode,
1480 static clib_error_t *
1481 show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
1482 vlib_cli_command_t * cmd)
1485 vnet_main_t *vnm = vnet_get_main ();
1486 vnet_device_input_runtime_t *rt;
1487 vnet_device_and_queue_t *dq;
1488 vlib_node_t *pn = vlib_get_node_by_name (vm, (u8 *) "device-input");
1493 foreach_vlib_main (({
1494 clib_bitmap_foreach (si, pn->sibling_bitmap,
1496 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1498 if (vec_len (rt->devices_and_queues))
1499 s = format (s, " node %U:\n", format_vlib_node_name, vm, si);
1501 vec_foreach (dq, rt->devices_and_queues)
1503 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm,
1505 s = format (s, " %U queue %u (%U)\n",
1506 format_vnet_sw_if_index_name, vnm, hi->sw_if_index,
1508 format_vnet_hw_interface_rx_mode, dq->mode);
1511 if (vec_len (s) > 0)
1513 vlib_cli_output(vm, "Thread %u (%s):\n%v", index,
1514 vlib_worker_threads[index].name, s);
1515 vec_reset_length (s);
1526 * This command is used to display the interface and queue worker
1530 * Example of how to display the interface placement:
1531 * @cliexstart{show interface rx-placement}
1532 * Thread 1 (vpp_wk_0):
1534 * GigabitEthernet7/0/0 queue 0 (polling)
1535 * node vhost-user-input:
1536 * VirtualEthernet0/0/12 queue 0 (polling)
1537 * VirtualEthernet0/0/12 queue 2 (polling)
1538 * VirtualEthernet0/0/13 queue 0 (polling)
1539 * VirtualEthernet0/0/13 queue 2 (polling)
1540 * Thread 2 (vpp_wk_1):
1542 * GigabitEthernet7/0/1 queue 0 (polling)
1543 * node vhost-user-input:
1544 * VirtualEthernet0/0/12 queue 1 (polling)
1545 * VirtualEthernet0/0/12 queue 3 (polling)
1546 * VirtualEthernet0/0/13 queue 1 (polling)
1547 * VirtualEthernet0/0/13 queue 3 (polling)
1551 VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
1552 .path = "show interface rx-placement",
1553 .short_help = "show interface rx-placement",
1554 .function = show_interface_rx_placement_fn,
1559 set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
1560 u32 thread_index, u8 is_main)
1562 vnet_main_t *vnm = vnet_get_main ();
1563 vnet_device_main_t *vdm = &vnet_device_main;
1564 clib_error_t *error = 0;
1565 vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
1571 thread_index += vdm->first_worker_thread_index;
1573 if (thread_index > vdm->last_worker_thread_index)
1574 return clib_error_return (0,
1575 "please specify valid worker thread or main");
1577 rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &mode);
1580 return clib_error_return (0, "not found");
1582 rv = vnet_hw_interface_unassign_rx_thread (vnm, hw_if_index, queue_id);
1585 return clib_error_return (0, "not found");
1587 vnet_hw_interface_assign_rx_thread (vnm, hw_if_index, queue_id,
1589 vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1594 static clib_error_t *
1595 set_interface_rx_placement (vlib_main_t * vm, unformat_input_t * input,
1596 vlib_cli_command_t * cmd)
1598 clib_error_t *error = 0;
1599 unformat_input_t _line_input, *line_input = &_line_input;
1600 vnet_main_t *vnm = vnet_get_main ();
1601 u32 hw_if_index = (u32) ~ 0;
1602 u32 queue_id = (u32) 0;
1603 u32 thread_index = (u32) ~ 0;
1606 if (!unformat_user (input, unformat_line_input, line_input))
1609 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1612 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1614 else if (unformat (line_input, "queue %d", &queue_id))
1616 else if (unformat (line_input, "main", &thread_index))
1618 else if (unformat (line_input, "worker %d", &thread_index))
1622 error = clib_error_return (0, "parse error: '%U'",
1623 format_unformat_error, line_input);
1624 unformat_free (line_input);
1629 unformat_free (line_input);
1631 if (hw_if_index == (u32) ~ 0)
1632 return clib_error_return (0, "please specify valid interface name");
1634 error = set_hw_interface_rx_placement (hw_if_index, queue_id, thread_index,
1641 * This command is used to assign a given interface, and optionally a
1642 * given queue, to a different thread. If the '<em>queue</em>' is not provided,
1643 * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
1644 * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
1647 * Example of how to display the interface placement:
1648 * @cliexstart{show interface rx-placement}
1649 * Thread 1 (vpp_wk_0):
1651 * GigabitEthernet7/0/0 queue 0 (polling)
1652 * node vhost-user-input:
1653 * VirtualEthernet0/0/12 queue 0 (polling)
1654 * VirtualEthernet0/0/12 queue 2 (polling)
1655 * VirtualEthernet0/0/13 queue 0 (polling)
1656 * VirtualEthernet0/0/13 queue 2 (polling)
1657 * Thread 2 (vpp_wk_1):
1659 * GigabitEthernet7/0/1 queue 0 (polling)
1660 * node vhost-user-input:
1661 * VirtualEthernet0/0/12 queue 1 (polling)
1662 * VirtualEthernet0/0/12 queue 3 (polling)
1663 * VirtualEthernet0/0/13 queue 1 (polling)
1664 * VirtualEthernet0/0/13 queue 3 (polling)
1666 * Example of how to assign a interface and queue to a worker thread:
1667 * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
1668 * Example of how to display the interface placement:
1669 * @cliexstart{show interface rx-placement}
1670 * Thread 1 (vpp_wk_0):
1672 * GigabitEthernet7/0/0 queue 0 (polling)
1673 * node vhost-user-input:
1674 * VirtualEthernet0/0/12 queue 0 (polling)
1675 * VirtualEthernet0/0/12 queue 1 (polling)
1676 * VirtualEthernet0/0/12 queue 2 (polling)
1677 * VirtualEthernet0/0/13 queue 0 (polling)
1678 * VirtualEthernet0/0/13 queue 2 (polling)
1679 * Thread 2 (vpp_wk_1):
1681 * GigabitEthernet7/0/1 queue 0 (polling)
1682 * node vhost-user-input:
1683 * VirtualEthernet0/0/12 queue 3 (polling)
1684 * VirtualEthernet0/0/13 queue 1 (polling)
1685 * VirtualEthernet0/0/13 queue 3 (polling)
1689 VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
1690 .path = "set interface rx-placement",
1691 .short_help = "set interface rx-placement <interface> [queue <n>] "
1692 "[worker <n> | main]",
1693 .function = set_interface_rx_placement,
1698 static inline clib_error_t *
1699 pcap_trace_command_internal (vlib_main_t * vm,
1700 unformat_input_t * input,
1701 vlib_cli_command_t * cmd, int rx_tx)
1703 unformat_input_t _line_input, *line_input = &_line_input;
1705 u8 *chroot_filename = 0;
1709 clib_error_t *error = 0;
1710 vnet_main_t *vnm = vnet_get_main ();
1712 /* Get a line of input. */
1713 if (!unformat_user (input, unformat_line_input, line_input))
1716 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1718 if (unformat (line_input, "on"))
1720 if (vm->pcap[rx_tx].pcap_enable == 0)
1723 vm->pcap[rx_tx].pcap_main.n_packets_to_capture =
1724 PCAP_DEF_PKT_TO_CAPTURE;
1728 vlib_cli_output (vm, "pcap %s capture already on...",
1729 (rx_tx == VLIB_RX) ? "rx" : "tx");
1734 else if (unformat (line_input, "off"))
1736 if (vm->pcap[rx_tx].pcap_enable)
1739 (vm, "captured %d pkts...",
1740 vm->pcap[rx_tx].pcap_main.n_packets_captured);
1741 if (vm->pcap[rx_tx].pcap_main.n_packets_captured)
1743 vm->pcap[rx_tx].pcap_main.n_packets_to_capture =
1744 vm->pcap[rx_tx].pcap_main.n_packets_captured;
1745 error = pcap_write (&vm->pcap[rx_tx].pcap_main);
1747 clib_error_report (error);
1749 vlib_cli_output (vm, "saved to %s...",
1750 vm->pcap[rx_tx].pcap_main.file_name);
1753 vm->pcap[rx_tx].pcap_enable = 0;
1757 vlib_cli_output (vm, "pcap %s capture already off...",
1758 (rx_tx == VLIB_RX) ? "rx" : "tx");
1763 else if (unformat (line_input, "max %d", &max))
1765 if (vm->pcap[rx_tx].pcap_enable)
1769 "can't change max value while pcap tx capture active...");
1773 vm->pcap[rx_tx].pcap_main.n_packets_to_capture = max;
1775 else if (unformat (line_input, "intfc %U",
1776 unformat_vnet_sw_interface, vnm,
1777 &vm->pcap[rx_tx].pcap_sw_if_index))
1780 else if (unformat (line_input, "intfc any"))
1782 vm->pcap[rx_tx].pcap_sw_if_index = 0;
1784 else if (unformat (line_input, "file %s", &filename))
1786 if (vm->pcap[rx_tx].pcap_enable)
1789 (vm, "can't change file while pcap tx capture active...");
1794 /* Brain-police user path input */
1795 if (strstr ((char *) filename, "..")
1796 || index ((char *) filename, '/'))
1798 vlib_cli_output (vm, "illegal characters in filename '%s'",
1800 vlib_cli_output (vm, "Hint: .. and / are not allowed.");
1801 vec_free (filename);
1806 chroot_filename = format (0, "/tmp/%s%c", filename, 0);
1807 vec_free (filename);
1809 else if (unformat (line_input, "status"))
1811 if (vm->pcap[rx_tx].pcap_sw_if_index == 0)
1814 (vm, "max is %d for any interface to file %s",
1815 vm->pcap[rx_tx].pcap_main.n_packets_to_capture,
1816 vm->pcap[rx_tx].pcap_main.file_name ?
1817 (u8 *) vm->pcap[rx_tx].pcap_main.file_name :
1818 (u8 *) "/tmp/vpe.pcap");
1822 vlib_cli_output (vm, "max is %d for interface %U to file %s",
1823 vm->pcap[rx_tx].pcap_main.n_packets_to_capture,
1824 format_vnet_sw_if_index_name, vnm,
1825 vm->pcap[rx_tx].pcap_sw_if_index,
1827 pcap_main.file_name ? (u8 *) vm->pcap[rx_tx].
1828 pcap_main.file_name : (u8 *) "/tmp/vpe.pcap");
1831 if (vm->pcap[rx_tx].pcap_enable == 0)
1833 vlib_cli_output (vm, "pcap %s capture is off...",
1834 (rx_tx == VLIB_RX) ? "rx" : "tx");
1838 vlib_cli_output (vm, "pcap %s capture is on: %d of %d pkts...",
1839 (rx_tx == VLIB_RX) ? "rx" : "tx",
1840 vm->pcap[rx_tx].pcap_main.n_packets_captured,
1842 pcap_main.n_packets_to_capture);
1849 error = clib_error_return (0, "unknown input `%U'",
1850 format_unformat_error, line_input);
1855 unformat_free (line_input);
1860 /* Since no error, save configured values. */
1861 if (chroot_filename)
1863 if (vm->pcap[rx_tx].pcap_main.file_name)
1864 vec_free (vm->pcap[rx_tx].pcap_main.file_name);
1865 vec_add1 (chroot_filename, 0);
1866 vm->pcap[rx_tx].pcap_main.file_name = (char *) chroot_filename;
1870 vm->pcap[rx_tx].pcap_main.n_packets_to_capture = max;
1874 if (vm->pcap[rx_tx].pcap_main.file_name == 0)
1875 vm->pcap[rx_tx].pcap_main.file_name
1876 = (char *) format (0, "/tmp/vpe.pcap%c", 0);
1878 vm->pcap[rx_tx].pcap_main.n_packets_captured = 0;
1879 vm->pcap[rx_tx].pcap_main.packet_type = PCAP_PACKET_TYPE_ethernet;
1880 if (vm->pcap[rx_tx].pcap_main.lock == 0)
1881 clib_spinlock_init (&(vm->pcap[rx_tx].pcap_main.lock));
1882 vm->pcap[rx_tx].pcap_enable = 1;
1883 vlib_cli_output (vm, "pcap %s capture on...",
1884 rx_tx == VLIB_RX ? "rx" : "tx");
1887 else if (chroot_filename)
1888 vec_free (chroot_filename);
1893 static clib_error_t *
1894 pcap_rx_trace_command_fn (vlib_main_t * vm,
1895 unformat_input_t * input, vlib_cli_command_t * cmd)
1897 return pcap_trace_command_internal (vm, input, cmd, VLIB_RX);
1900 static clib_error_t *
1901 pcap_tx_trace_command_fn (vlib_main_t * vm,
1902 unformat_input_t * input, vlib_cli_command_t * cmd)
1904 return pcap_trace_command_internal (vm, input, cmd, VLIB_TX);
1909 * This command is used to start or stop a packet capture, or show
1910 * the status of packet capture. Note that both "pcap rx trace" and
1911 * "pcap tx trace" are implemented. The command syntax is identical,
1912 * simply substitute rx for tx as needed.
1914 * This command has the following optional parameters:
1916 * - <b>on|off</b> - Used to start or stop a packet capture.
1918 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
1919 * of packets have been received, buffer is flushed to file. Once another
1920 * '<em>nn</em>' number of packets have been received, buffer is flushed
1921 * to file, overwriting previous write. If not entered, value defaults
1922 * to 100. Can only be updated if packet capture is off.
1924 * - <b>intfc <interface>|any</b> - Used to specify a given interface,
1925 * or use '<em>any</em>' to run packet capture on all interfaces.
1926 * '<em>any</em>' is the default if not provided. Settings from a previous
1927 * packet capture are preserved, so '<em>any</em>' can be used to reset
1928 * the interface setting.
1930 * - <b>file <name></b> - Used to specify the output filename. The file will
1931 * be placed in the '<em>/tmp</em>' directory, so only the filename is
1932 * supported. Directory should not be entered. If file already exists, file
1933 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
1934 * will be used. Can only be updated if packet capture is off.
1936 * - <b>status</b> - Displays the current status and configured attributes
1937 * associated with a packet capture. If packet capture is in progress,
1938 * '<em>status</em>' also will return the number of packets currently in
1939 * the local buffer. All additional attributes entered on command line
1940 * with '<em>status</em>' will be ignored and not applied.
1943 * Example of how to display the status of a tx packet capture when off:
1944 * @cliexstart{pcap tx trace status}
1945 * max is 100, for any interface to file /tmp/vpe.pcap
1946 * pcap tx capture is off...
1948 * Example of how to start a tx packet capture:
1949 * @cliexstart{pcap tx trace on max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
1950 * pcap tx capture on...
1952 * Example of how to display the status of a tx packet capture in progress:
1953 * @cliexstart{pcap tx trace status}
1954 * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
1955 * pcap tx capture is on: 20 of 35 pkts...
1957 * Example of how to stop a tx packet capture:
1958 * @cliexstart{vppctl pcap tx trace off}
1959 * captured 21 pkts...
1960 * saved to /tmp/vppTest.pcap...
1965 VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
1966 .path = "pcap tx trace",
1968 "pcap tx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
1969 .function = pcap_tx_trace_command_fn,
1971 VLIB_CLI_COMMAND (pcap_rx_trace_command, static) = {
1972 .path = "pcap rx trace",
1974 "pcap rx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
1975 .function = pcap_rx_trace_command_fn,
1981 * fd.io coding-style-patch-verification: ON
1984 * eval: (c-set-style "gnu")