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 vnet_interface_main_t *im = &vnm->interface_main;
274 vnet_sw_interface_t *si, *sorted_sis = 0;
275 u32 sw_if_index = ~(u32) 0;
276 u8 show_addresses = 0;
277 u8 show_features = 0;
280 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
282 /* See if user wants to show specific interface */
284 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
286 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
287 vec_add1 (sorted_sis, si[0]);
289 else if (unformat (input, "address") || unformat (input, "addr"))
291 else if (unformat (input, "features") || unformat (input, "feat"))
293 else if (unformat (input, "tag"))
297 error = clib_error_return (0, "unknown input `%U'",
298 format_unformat_error, input);
303 if (show_features || show_tag)
305 if (sw_if_index == ~(u32) 0)
306 return clib_error_return (0, "Interface not specified...");
311 vnet_interface_features_show (vm, sw_if_index);
313 l2_input_config_t *l2_input = l2input_intf_config (sw_if_index);
314 u32 fb = l2_input->feature_bitmap;
315 /* intf input features are masked by bridge domain */
316 if (l2_input->bridge)
317 fb &= l2input_bd_config (l2_input->bd_index)->feature_bitmap;
318 vlib_cli_output (vm, "\nl2-input:\n%U", format_l2_input_features, fb);
320 l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
321 vlib_cli_output (vm, "\nl2-output:");
322 if (l2_output->out_vtr_flag)
323 vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
324 vlib_cli_output (vm, "%U", format_l2_output_features,
325 l2_output->feature_bitmap);
331 tag = vnet_get_sw_interface_tag (vnm, sw_if_index);
332 vlib_cli_output (vm, "%U: %s",
333 format_vnet_sw_if_index_name, vnm, sw_if_index,
334 tag ? (char *) tag : "(none)");
339 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, 0);
341 if (vec_len (sorted_sis) == 0) /* Get all interfaces */
343 /* Gather interfaces. */
345 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
346 _vec_len (sorted_sis) = 0;
347 pool_foreach (si, im->sw_interfaces, (
350 vnet_swif_is_api_visible (si);
352 vec_add1 (sorted_sis, si[0]);}
356 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
361 vec_foreach (si, sorted_sis)
363 ip4_main_t *im4 = &ip4_main;
364 ip6_main_t *im6 = &ip6_main;
365 ip_lookup_main_t *lm4 = &im4->lookup_main;
366 ip_lookup_main_t *lm6 = &im6->lookup_main;
367 ip_interface_address_t *ia = 0;
370 u32 fib_index4 = 0, fib_index6 = 0;
374 if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
375 fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
378 if (vec_len (im6->fib_index_by_sw_if_index) > si->sw_if_index)
379 fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
382 fib4 = ip4_fib_get (fib_index4);
383 fib6 = ip6_fib_get (fib_index6);
385 if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
387 (vm, "%U (%s): \n unnumbered, use %U",
388 format_vnet_sw_if_index_name,
389 vnm, si->sw_if_index,
390 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
391 format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
395 vlib_cli_output (vm, "%U (%s):",
396 format_vnet_sw_if_index_name,
397 vnm, si->sw_if_index,
398 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
402 /* Display any L2 info */
403 l2_input_config_t *l2_input = l2input_intf_config (si->sw_if_index);
404 if (l2_input->bridge)
406 u32 bd_id = l2input_main.bd_configs[l2_input->bd_index].bd_id;
407 vlib_cli_output (vm, " l2 bridge bd_id %d%s%d", bd_id,
408 l2_input->bvi ? " bvi shg " : " shg ",
411 else if (l2_input->xconnect)
413 vlib_cli_output (vm, " l2 xconnect %U",
414 format_vnet_sw_if_index_name,
415 vnm, l2_input->output_sw_if_index);
418 /* Display any IP4 addressing info */
420 foreach_ip_interface_address (lm4, ia, si->sw_if_index,
421 1 /* honor unnumbered */,
423 r4 = ip_interface_address_get_address (lm4, ia);
426 vlib_cli_output (vm, " %U/%d table %d",
427 format_ip4_address, r4,
433 vlib_cli_output (vm, " %U/%d",
434 format_ip4_address, r4,
440 /* Display any IP6 addressing info */
442 foreach_ip_interface_address (lm6, ia, si->sw_if_index,
443 1 /* honor unnumbered */,
445 r6 = ip_interface_address_get_address (lm6, ia);
448 vlib_cli_output (vm, " %U/%d table %d",
449 format_ip6_address, r6,
455 vlib_cli_output (vm, " %U/%d",
456 format_ip6_address, r6,
465 vec_foreach (si, sorted_sis)
467 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, si);
472 vec_free (sorted_sis);
477 VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
478 .path = "show interface",
479 .short_help = "show interface [address|addr|features|feat] [<interface> [<interface> [..]]]",
480 .function = show_sw_interfaces,
484 /* Root of all interface commands. */
486 VLIB_CLI_COMMAND (vnet_cli_interface_command, static) = {
488 .short_help = "Interface commands",
493 VLIB_CLI_COMMAND (vnet_cli_set_interface_command, static) = {
494 .path = "set interface",
495 .short_help = "Interface commands",
499 static clib_error_t *
500 clear_interface_counters (vlib_main_t * vm,
501 unformat_input_t * input, vlib_cli_command_t * cmd)
503 vnet_main_t *vnm = vnet_get_main ();
504 vnet_interface_main_t *im = &vnm->interface_main;
505 vlib_simple_counter_main_t *sm;
506 vlib_combined_counter_main_t *cm;
507 static vnet_main_t **my_vnet_mains;
508 int i, j, n_counters;
510 vec_reset_length (my_vnet_mains);
512 for (i = 0; i < vec_len (vnet_mains); i++)
515 vec_add1 (my_vnet_mains, vnet_mains[i]);
518 if (vec_len (vnet_mains) == 0)
519 vec_add1 (my_vnet_mains, vnm);
521 n_counters = vec_len (im->combined_sw_if_counters);
523 for (j = 0; j < n_counters; j++)
525 for (i = 0; i < vec_len (my_vnet_mains); i++)
527 im = &my_vnet_mains[i]->interface_main;
528 cm = im->combined_sw_if_counters + j;
529 vlib_clear_combined_counters (cm);
533 n_counters = vec_len (im->sw_if_counters);
535 for (j = 0; j < n_counters; j++)
537 for (i = 0; i < vec_len (my_vnet_mains); i++)
539 im = &my_vnet_mains[i]->interface_main;
540 sm = im->sw_if_counters + j;
541 vlib_clear_simple_counters (sm);
549 * Clear the statistics for all interfaces (statistics associated with the
550 * '<em>show interface</em>' command).
553 * Example of how to clear the statistics for all interfaces:
554 * @cliexcmd{clear interfaces}
557 VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
558 .path = "clear interfaces",
559 .short_help = "clear interfaces",
560 .function = clear_interface_counters,
565 * Parse subinterface names.
567 * The following subinterface syntax is supported. The first two are for
568 * backwards compatability:
571 * - a subinterface with the name <intf-name>.<id>. The subinterface
572 * is a single dot1q vlan with vlan id <id> and exact-match semantics.
574 * <intf-name> <min_id>-<max_id>
575 * - a set of the above subinterfaces, repeating for each id
576 * in the range <min_id> to <max_id>
578 * In the following, exact-match semantics (i.e. the number of vlan tags on the
579 * packet must match the number of tags in the configuration) are used only if
580 * the keyword exact-match is present. Non-exact match is the default.
582 * <intf-name> <id> dot1q <outer_id> [exact-match]
583 * - a subinterface with the name <intf-name>.<id>. The subinterface
584 * is a single dot1q vlan with vlan id <outer_id>.
586 * <intf-name> <id> dot1q any [exact-match]
587 * - a subinterface with the name <intf-name>.<id>. The subinterface
588 * is a single dot1q vlan with any vlan id.
590 * <intf-name> <id> dot1q <outer_id> inner-dot1q <inner_id> [exact-match]
591 * - a subinterface with the name <intf-name>.<id>. The subinterface
592 * is a double dot1q vlan with outer vlan id <outer_id> and inner vlan id
595 * <intf-name> <id> dot1q <outer_id> inner-dot1q any [exact-match]
596 * - a subinterface with the name <intf-name>.<id>. The subinterface
597 * is a double dot1q vlan with outer vlan id <id> and any inner vlan id.
599 * <intf-name> <id> dot1q any inner-dot1q any [exact-match]
601 * - a subinterface with the name <intf-name>.<id>. The subinterface
602 * is a double dot1q vlan with any outer vlan id and any inner vlan id.
604 * For each of the above CLI, there is a duplicate that uses the keyword
605 * "dot1ad" in place of the first "dot1q". These interfaces use ethertype
606 * 0x88ad in place of 0x8100 for the outer ethertype. Note that for double-
607 * tagged packets the inner ethertype is always 0x8100. Also note that
608 * the dot1q and dot1ad naming spaces are independent, so it is legal to
609 * have both "Gig3/0/0.1 dot1q 100" and "Gig3/0/0.2 dot1ad 100". For example:
611 * <intf-name> <id> dot1ad <outer_id> inner-dot1q <inner_id> [exact-match]
612 * - a subinterface with the name <intf-name>.<id>. The subinterface
613 * is a double dot1ad vlan with outer vlan id <outer_id> and inner vlan
616 * <intf-name> <id> untagged
617 * - a subinterface with the name <intf-name>.<id>. The subinterface
618 * has no vlan tags. Only one can be specified per interface.
620 * <intf-name> <id> default
621 * - a subinterface with the name <intf-name>.<id>. This is associated
622 * with a packet that did not match any other configured subinterface
623 * on this interface. Only one can be specified per interface.
626 static clib_error_t *
627 parse_vlan_sub_interfaces (unformat_input_t * input,
628 vnet_sw_interface_t * template)
630 clib_error_t *error = 0;
631 u32 inner_vlan, outer_vlan;
633 if (unformat (input, "any inner-dot1q any"))
635 template->sub.eth.flags.two_tags = 1;
636 template->sub.eth.flags.outer_vlan_id_any = 1;
637 template->sub.eth.flags.inner_vlan_id_any = 1;
639 else if (unformat (input, "any"))
641 template->sub.eth.flags.one_tag = 1;
642 template->sub.eth.flags.outer_vlan_id_any = 1;
644 else if (unformat (input, "%d inner-dot1q any", &outer_vlan))
646 template->sub.eth.flags.two_tags = 1;
647 template->sub.eth.flags.inner_vlan_id_any = 1;
648 template->sub.eth.outer_vlan_id = outer_vlan;
650 else if (unformat (input, "%d inner-dot1q %d", &outer_vlan, &inner_vlan))
652 template->sub.eth.flags.two_tags = 1;
653 template->sub.eth.outer_vlan_id = outer_vlan;
654 template->sub.eth.inner_vlan_id = inner_vlan;
656 else if (unformat (input, "%d", &outer_vlan))
658 template->sub.eth.flags.one_tag = 1;
659 template->sub.eth.outer_vlan_id = outer_vlan;
663 error = clib_error_return (0, "expected dot1q config, got `%U'",
664 format_unformat_error, input);
668 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
670 if (unformat (input, "exact-match"))
672 template->sub.eth.flags.exact_match = 1;
680 static clib_error_t *
681 create_sub_interfaces (vlib_main_t * vm,
682 unformat_input_t * input, vlib_cli_command_t * cmd)
684 vnet_main_t *vnm = vnet_get_main ();
685 clib_error_t *error = 0;
686 u32 hw_if_index, sw_if_index;
687 vnet_hw_interface_t *hi;
688 u32 id, id_min, id_max;
689 vnet_sw_interface_t template;
692 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
694 error = clib_error_return (0, "unknown interface `%U'",
695 format_unformat_error, input);
699 memset (&template, 0, sizeof (template));
700 template.sub.eth.raw_flags = 0;
702 if (unformat (input, "%d default", &id_min))
705 template.sub.eth.flags.default_sub = 1;
707 else if (unformat (input, "%d untagged", &id_min))
710 template.sub.eth.flags.no_tags = 1;
711 template.sub.eth.flags.exact_match = 1;
713 else if (unformat (input, "%d dot1q", &id_min))
715 /* parse dot1q config */
717 error = parse_vlan_sub_interfaces (input, &template);
721 else if (unformat (input, "%d dot1ad", &id_min))
723 /* parse dot1ad config */
725 template.sub.eth.flags.dot1ad = 1;
726 error = parse_vlan_sub_interfaces (input, &template);
730 else if (unformat (input, "%d-%d", &id_min, &id_max))
732 template.sub.eth.flags.one_tag = 1;
733 template.sub.eth.flags.exact_match = 1;
737 else if (unformat (input, "%d", &id_min))
740 template.sub.eth.flags.one_tag = 1;
741 template.sub.eth.outer_vlan_id = id_min;
742 template.sub.eth.flags.exact_match = 1;
747 error = clib_error_return (0, "expected ID or ID MIN-MAX, got `%U'",
748 format_unformat_error, input);
752 hi = vnet_get_hw_interface (vnm, hw_if_index);
754 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
757 clib_error_return (0,
758 "not allowed as %v belong to a BondEthernet interface",
763 for (id = id_min; id <= id_max; id++)
766 vnet_interface_main_t *im = &vnm->interface_main;
767 u64 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
770 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
774 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
775 hi->sw_if_index, id);
779 kp = clib_mem_alloc (sizeof (*kp));
780 *kp = sup_and_sub_key;
782 template.type = VNET_SW_INTERFACE_TYPE_SUB;
783 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
784 template.sup_sw_if_index = hi->sw_if_index;
785 template.sub.id = id;
787 template.sub.eth.outer_vlan_id = id;
789 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
793 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
794 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
795 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
796 vnet_get_main (), sw_if_index);
804 * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
805 * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
806 * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
807 * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
808 * but this is not recommended.
810 * This command has several variations:
811 * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
812 * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
814 * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
815 * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
816 * match any other subinterfaces should be sent to this subinterface.
818 * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
819 * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
820 * to this subinterface.
822 * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
823 * subinterfaces to handle a range of VLAN IDs.
825 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
826 * Use this command to specify the outer VLAN ID, to either be explicited or to make the
827 * VLAN ID different from the '<em>subId</em>'.
829 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
830 * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
831 * the innner VLAN ID.
833 * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explictly entered, subinterfaces
834 * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
835 * default. If '<em>exact-match</em>' is specified, packets must have the same number of
836 * VLAN tags as the configuration. For non-exact-match, packets must at least that number
837 * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
838 * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
839 * entered, then the default behavior is exact-match.
841 * Use the '<em>show interface</em>' command to display all subinterfaces.
845 * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
846 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
848 * The previous example is shorthand and is equivalent to:
849 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
852 * Example of how to create a subinterface number that is different from the VLAN ID:
853 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
856 * Examples of how to create q-in-q and q-in-any subinterfaces:
857 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
858 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
860 * Examples of how to create dot1ad interfaces:
861 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
862 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
865 * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
866 * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
867 * is non-exact match:
868 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
870 * However, the same packet would NOT match this interface because '<em>exact-match</em>'
871 * is specified and only one VLAN is configured, but packet contains two VLANs:
872 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
875 * Example of how to created a subinterface to process untagged packets:
876 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
878 * Example of how to created a subinterface to process any packet with a VLAN ID that
879 * does not match any other subinterface:
880 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
882 * When subinterfaces are created, they are in the down state. Example of how to
883 * enable a newly created subinterface:
884 * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
888 VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
889 .path = "create sub-interfaces",
890 .short_help = "create sub-interfaces <interface> "
891 "{<subId> [default|untagged]} | "
892 "{<subId>-<subId>} | "
893 "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
894 .function = create_sub_interfaces,
898 static clib_error_t *
899 set_state (vlib_main_t * vm,
900 unformat_input_t * input, vlib_cli_command_t * cmd)
902 vnet_main_t *vnm = vnet_get_main ();
904 u32 sw_if_index, flags;
907 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
909 error = clib_error_return (0, "unknown interface `%U'",
910 format_unformat_error, input);
914 if (!unformat (input, "%U", unformat_vnet_sw_interface_flags, &flags))
916 error = clib_error_return (0, "unknown flags `%U'",
917 format_unformat_error, input);
921 error = vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
931 * This command is used to change the admin state (up/down) of an interface.
933 * If an interface is down, the optional '<em>punt</em>' flag can also be set.
934 * The '<em>punt</em>' flag implies the interface is disabled for forwarding
935 * but punt all traffic to slow-path. Use the '<em>enable</em>' flag to clear
936 * '<em>punt</em>' flag (interface is still down).
939 * Example of how to configure the admin state of an interface to '<em>up</em?':
940 * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
941 * Example of how to configure the admin state of an interface to '<em>down</em?':
942 * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
945 VLIB_CLI_COMMAND (set_state_command, static) = {
946 .path = "set interface state",
947 .short_help = "set interface state <interface> [up|down|punt|enable]",
948 .function = set_state,
952 static clib_error_t *
953 set_unnumbered (vlib_main_t * vm,
954 unformat_input_t * input, vlib_cli_command_t * cmd)
956 vnet_main_t *vnm = vnet_get_main ();
957 u32 unnumbered_sw_if_index;
958 u32 inherit_from_sw_if_index;
959 vnet_sw_interface_t *si;
964 if (unformat (input, "%U use %U",
965 unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
966 unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
968 else if (unformat (input, "del %U",
969 unformat_vnet_sw_interface, vnm,
970 &unnumbered_sw_if_index))
973 return clib_error_return (0, "parse error '%U'",
974 format_unformat_error, input);
976 si = vnet_get_sw_interface (vnm, unnumbered_sw_if_index);
977 was_unnum = (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED);
981 si->flags &= ~(VNET_SW_INTERFACE_FLAG_UNNUMBERED);
982 si->unnumbered_sw_if_index = (u32) ~ 0;
984 ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
985 [unnumbered_sw_if_index] = ~0;
986 ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
987 [unnumbered_sw_if_index] = ~0;
991 si->flags |= VNET_SW_INTERFACE_FLAG_UNNUMBERED;
992 si->unnumbered_sw_if_index = inherit_from_sw_if_index;
994 ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
995 [unnumbered_sw_if_index] =
996 ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
997 [inherit_from_sw_if_index];
998 ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
999 [unnumbered_sw_if_index] =
1000 ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
1001 [inherit_from_sw_if_index];
1004 if (was_unnum != (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED))
1006 ip4_sw_interface_enable_disable (unnumbered_sw_if_index, !is_del);
1007 ip6_sw_interface_enable_disable (unnumbered_sw_if_index, !is_del);
1014 VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
1015 .path = "set interface unnumbered",
1016 .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
1017 .function = set_unnumbered,
1023 static clib_error_t *
1024 set_hw_class (vlib_main_t * vm,
1025 unformat_input_t * input, vlib_cli_command_t * cmd)
1027 vnet_main_t *vnm = vnet_get_main ();
1028 vnet_interface_main_t *im = &vnm->interface_main;
1029 clib_error_t *error;
1030 u32 hw_if_index, hw_class_index;
1033 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1035 error = clib_error_return (0, "unknown hardware interface `%U'",
1036 format_unformat_error, input);
1040 if (!unformat_user (input, unformat_hash_string,
1041 im->hw_interface_class_by_name, &hw_class_index))
1043 error = clib_error_return (0, "unknown hardware class `%U'",
1044 format_unformat_error, input);
1048 error = vnet_hw_interface_set_class (vnm, hw_if_index, hw_class_index);
1057 VLIB_CLI_COMMAND (set_hw_class_command, static) = {
1058 .path = "set interface hw-class",
1059 .short_help = "Set interface hardware class",
1060 .function = set_hw_class,
1064 static clib_error_t *
1065 vnet_interface_cli_init (vlib_main_t * vm)
1070 VLIB_INIT_FUNCTION (vnet_interface_cli_init);
1072 static clib_error_t *
1073 renumber_interface_command_fn (vlib_main_t * vm,
1074 unformat_input_t * input,
1075 vlib_cli_command_t * cmd)
1078 u32 new_dev_instance;
1079 vnet_main_t *vnm = vnet_get_main ();
1082 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1083 return clib_error_return (0, "unknown hardware interface `%U'",
1084 format_unformat_error, input);
1086 if (!unformat (input, "%d", &new_dev_instance))
1087 return clib_error_return (0, "new dev instance missing");
1089 rv = vnet_interface_name_renumber (hw_if_index, new_dev_instance);
1097 return clib_error_return (0, "vnet_interface_name_renumber returned %d",
1107 VLIB_CLI_COMMAND (renumber_interface_command, static) = {
1108 .path = "renumber interface",
1109 .short_help = "renumber interface <interface> <new-dev-instance>",
1110 .function = renumber_interface_command_fn,
1114 static clib_error_t *
1115 promiscuous_cmd (vlib_main_t * vm,
1116 unformat_input_t * input, vlib_cli_command_t * cmd)
1118 vnet_main_t *vnm = vnet_get_main ();
1120 u32 flags = ETHERNET_INTERFACE_FLAG_ACCEPT_ALL;
1121 ethernet_main_t *em = ðernet_main;
1122 ethernet_interface_t *eif;
1124 if (unformat (input, "on %U",
1125 unformat_vnet_hw_interface, vnm, &hw_if_index))
1127 else if (unformat (input, "off %U",
1128 unformat_ethernet_interface, vnm, &hw_if_index))
1131 return clib_error_return (0, "unknown input `%U'",
1132 format_unformat_error, input);
1134 eif = ethernet_get_interface (em, hw_if_index);
1136 return clib_error_return (0, "not supported");
1138 ethernet_set_flags (vnm, hw_if_index, flags);
1143 VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
1144 .path = "set interface promiscuous",
1145 .short_help = "set interface promiscuous [on|off] <interface>",
1146 .function = promiscuous_cmd,
1150 static clib_error_t *
1151 mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1153 vnet_main_t *vnm = vnet_get_main ();
1154 u32 hw_if_index, mtu;
1155 u32 flags = ETHERNET_INTERFACE_FLAG_MTU;
1156 ethernet_main_t *em = ðernet_main;
1158 if (unformat (input, "%d %U", &mtu,
1159 unformat_vnet_hw_interface, vnm, &hw_if_index))
1161 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1162 ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
1165 return clib_error_return (0, "not supported");
1167 if (mtu < hi->min_supported_packet_bytes)
1168 return clib_error_return (0, "Invalid mtu (%d): "
1169 "must be >= min pkt bytes (%d)", mtu,
1170 hi->min_supported_packet_bytes);
1172 if (mtu > hi->max_supported_packet_bytes)
1173 return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
1174 hi->max_supported_packet_bytes);
1176 if (hi->max_packet_bytes != mtu)
1178 hi->max_packet_bytes = mtu;
1179 ethernet_set_flags (vnm, hw_if_index, flags);
1183 return clib_error_return (0, "unknown input `%U'",
1184 format_unformat_error, input);
1189 VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
1190 .path = "set interface mtu",
1191 .short_help = "set interface mtu <value> <interface>",
1192 .function = mtu_cmd,
1196 static clib_error_t *
1197 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
1198 vlib_cli_command_t * cmd)
1200 vnet_main_t *vnm = vnet_get_main ();
1201 vnet_sw_interface_t *si = NULL;
1202 clib_error_t *error = 0;
1203 u32 sw_if_index = ~0;
1206 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1208 error = clib_error_return (0, "unknown interface `%U'",
1209 format_unformat_error, input);
1212 if (!unformat_user (input, unformat_ethernet_address, mac))
1214 error = clib_error_return (0, "expected mac address `%U'",
1215 format_unformat_error, input);
1218 si = vnet_get_sw_interface (vnm, sw_if_index);
1219 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
1225 * The '<em>set interface mac address </em>' command allows to set MAC address of given interface.
1226 * In case of NIC interfaces the one has to support MAC address change. A side effect of MAC address
1227 * change are changes of MAC addresses in FIB tables (ipv4 and ipv6).
1231 * Example of how to change MAC Address of interface:
1232 * @cliexcmd{set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01}
1233 * @cliexcmd{set interface mac address host-vpp0 aa:bb:cc:dd:ee:02}
1234 * @cliexcmd{set interface mac address tap-0 aa:bb:cc:dd:ee:03}
1235 * @cliexcmd{set interface mac address pg0 aa:bb:cc:dd:ee:04}
1239 VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
1240 .path = "set interface mac address",
1241 .short_help = "set interface mac address <interface> <mac-address>",
1242 .function = set_interface_mac_address,
1246 static clib_error_t *
1247 set_tag (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1249 vnet_main_t *vnm = vnet_get_main ();
1250 u32 sw_if_index = ~0;
1253 if (!unformat (input, "%U %s", unformat_vnet_sw_interface,
1254 vnm, &sw_if_index, &tag))
1255 return clib_error_return (0, "unknown input `%U'",
1256 format_unformat_error, input);
1258 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
1264 VLIB_CLI_COMMAND (set_tag_command, static) = {
1265 .path = "set interface tag",
1266 .short_help = "set interface tag <interface> <tag>",
1267 .function = set_tag,
1271 static clib_error_t *
1272 clear_tag (vlib_main_t * vm, unformat_input_t * input,
1273 vlib_cli_command_t * cmd)
1275 vnet_main_t *vnm = vnet_get_main ();
1276 u32 sw_if_index = ~0;
1278 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1279 return clib_error_return (0, "unknown input `%U'",
1280 format_unformat_error, input);
1282 vnet_clear_sw_interface_tag (vnm, sw_if_index);
1288 VLIB_CLI_COMMAND (clear_tag_command, static) = {
1289 .path = "clear interface tag",
1290 .short_help = "clear interface tag <interface>",
1291 .function = clear_tag,
1295 static clib_error_t *
1296 set_hw_interface_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1297 u32 queue_id, vnet_hw_interface_rx_mode mode)
1299 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1300 vnet_device_class_t *dev_class =
1301 vnet_get_device_class (vnm, hw->dev_class_index);
1302 clib_error_t *error;
1303 vnet_hw_interface_rx_mode old_mode;
1306 if (mode == VNET_HW_INTERFACE_RX_MODE_DEFAULT)
1307 mode = hw->default_rx_mode;
1309 rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &old_mode);
1313 if (old_mode == mode)
1314 return 0; /* same rx-mode, no change */
1316 case VNET_API_ERROR_INVALID_INTERFACE:
1317 return clib_error_return (0, "invalid interface");
1318 case VNET_API_ERROR_INVALID_QUEUE:
1319 return clib_error_return (0, "invalid queue");
1321 return clib_error_return (0, "unknown error");
1324 if (dev_class->rx_mode_change_function)
1326 error = dev_class->rx_mode_change_function (vnm, hw_if_index, queue_id,
1332 rv = vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1337 case VNET_API_ERROR_UNSUPPORTED:
1338 return clib_error_return (0, "unsupported");
1339 case VNET_API_ERROR_INVALID_INTERFACE:
1340 return clib_error_return (0, "invalid interface");
1341 case VNET_API_ERROR_INVALID_QUEUE:
1342 return clib_error_return (0, "invalid queue");
1344 return clib_error_return (0, "unknown error");
1351 set_hw_interface_change_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1352 u8 queue_id_valid, u32 queue_id,
1353 vnet_hw_interface_rx_mode mode)
1355 clib_error_t *error = 0;
1356 vnet_hw_interface_t *hw;
1359 hw = vnet_get_hw_interface (vnm, hw_if_index);
1361 if (queue_id_valid == 0)
1363 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1365 error = set_hw_interface_rx_mode (vnm, hw_if_index, i, mode);
1369 hw->default_rx_mode = mode;
1372 error = set_hw_interface_rx_mode (vnm, hw_if_index, queue_id, mode);
1377 static clib_error_t *
1378 set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
1379 vlib_cli_command_t * cmd)
1381 clib_error_t *error = 0;
1382 unformat_input_t _line_input, *line_input = &_line_input;
1383 vnet_main_t *vnm = vnet_get_main ();
1384 u32 hw_if_index = (u32) ~ 0;
1385 u32 queue_id = (u32) ~ 0;
1386 vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
1387 u8 queue_id_valid = 0;
1389 if (!unformat_user (input, unformat_line_input, line_input))
1392 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1395 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1397 else if (unformat (line_input, "queue %d", &queue_id))
1399 else if (unformat (line_input, "polling"))
1400 mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
1401 else if (unformat (line_input, "interrupt"))
1402 mode = VNET_HW_INTERFACE_RX_MODE_INTERRUPT;
1403 else if (unformat (line_input, "adaptive"))
1404 mode = VNET_HW_INTERFACE_RX_MODE_ADAPTIVE;
1407 error = clib_error_return (0, "parse error: '%U'",
1408 format_unformat_error, line_input);
1409 unformat_free (line_input);
1414 unformat_free (line_input);
1416 if (hw_if_index == (u32) ~ 0)
1417 return clib_error_return (0, "please specify valid interface name");
1419 if (mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
1420 return clib_error_return (0, "please specify valid rx-mode");
1422 error = set_hw_interface_change_rx_mode (vnm, hw_if_index, queue_id_valid,
1429 * This command is used to assign the RX packet processing mode (polling,
1430 * interrupt, adaptive) of the a given interface, and optionally a
1431 * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
1432 * is applied to all queues of the interface. Not all interfaces support
1433 * all modes. To display the current rx-mode use the command
1434 * '<em>show interface rx-placement</em>'.
1437 * Example of how to assign rx-mode to all queues on an interface:
1438 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
1439 * Example of how to assign rx-mode to one queue of an interface:
1440 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
1441 * Example of how to display the rx-mode of all interfaces:
1442 * @cliexstart{show interface rx-placement}
1443 * Thread 1 (vpp_wk_0):
1445 * GigabitEthernet7/0/0 queue 0 (polling)
1446 * node vhost-user-input:
1447 * VirtualEthernet0/0/12 queue 0 (interrupt)
1448 * VirtualEthernet0/0/12 queue 2 (polling)
1449 * VirtualEthernet0/0/13 queue 0 (polling)
1450 * VirtualEthernet0/0/13 queue 2 (polling)
1451 * Thread 2 (vpp_wk_1):
1453 * GigabitEthernet7/0/1 queue 0 (polling)
1454 * node vhost-user-input:
1455 * VirtualEthernet0/0/12 queue 1 (polling)
1456 * VirtualEthernet0/0/12 queue 3 (polling)
1457 * VirtualEthernet0/0/13 queue 1 (polling)
1458 * VirtualEthernet0/0/13 queue 3 (polling)
1462 VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
1463 .path = "set interface rx-mode",
1464 .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
1465 .function = set_interface_rx_mode,
1469 static clib_error_t *
1470 show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
1471 vlib_cli_command_t * cmd)
1474 vnet_main_t *vnm = vnet_get_main ();
1475 vnet_device_input_runtime_t *rt;
1476 vnet_device_and_queue_t *dq;
1477 vlib_node_t *pn = vlib_get_node_by_name (vm, (u8 *) "device-input");
1482 foreach_vlib_main (({
1483 clib_bitmap_foreach (si, pn->sibling_bitmap,
1485 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1487 if (vec_len (rt->devices_and_queues))
1488 s = format (s, " node %U:\n", format_vlib_node_name, vm, si);
1490 vec_foreach (dq, rt->devices_and_queues)
1492 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm,
1494 s = format (s, " %U queue %u (%U)\n",
1495 format_vnet_sw_if_index_name, vnm, hi->sw_if_index,
1497 format_vnet_hw_interface_rx_mode, dq->mode);
1500 if (vec_len (s) > 0)
1502 vlib_cli_output(vm, "Thread %u (%v):\n%v", index,
1503 vlib_worker_threads[index].name, s);
1504 vec_reset_length (s);
1515 * This command is used to display the interface and queue worker
1519 * Example of how to display the interface placement:
1520 * @cliexstart{show interface rx-placement}
1521 * Thread 1 (vpp_wk_0):
1523 * GigabitEthernet7/0/0 queue 0 (polling)
1524 * node vhost-user-input:
1525 * VirtualEthernet0/0/12 queue 0 (polling)
1526 * VirtualEthernet0/0/12 queue 2 (polling)
1527 * VirtualEthernet0/0/13 queue 0 (polling)
1528 * VirtualEthernet0/0/13 queue 2 (polling)
1529 * Thread 2 (vpp_wk_1):
1531 * GigabitEthernet7/0/1 queue 0 (polling)
1532 * node vhost-user-input:
1533 * VirtualEthernet0/0/12 queue 1 (polling)
1534 * VirtualEthernet0/0/12 queue 3 (polling)
1535 * VirtualEthernet0/0/13 queue 1 (polling)
1536 * VirtualEthernet0/0/13 queue 3 (polling)
1540 VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
1541 .path = "show interface rx-placement",
1542 .short_help = "show interface rx-placement",
1543 .function = show_interface_rx_placement_fn,
1547 static clib_error_t *
1548 set_interface_rx_placement (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 vnet_device_main_t *vdm = &vnet_device_main;
1555 vnet_hw_interface_rx_mode mode;
1556 u32 hw_if_index = (u32) ~ 0;
1557 u32 queue_id = (u32) 0;
1558 u32 thread_index = (u32) ~ 0;
1561 if (!unformat_user (input, unformat_line_input, line_input))
1564 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1567 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1569 else if (unformat (line_input, "queue %d", &queue_id))
1571 else if (unformat (line_input, "main", &thread_index))
1573 else if (unformat (line_input, "worker %d", &thread_index))
1574 thread_index += vdm->first_worker_thread_index;
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 (thread_index > vdm->last_worker_thread_index)
1590 return clib_error_return (0,
1591 "please specify valid worker thread or main");
1593 rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &mode);
1596 return clib_error_return (0, "not found");
1598 rv = vnet_hw_interface_unassign_rx_thread (vnm, hw_if_index, queue_id);
1601 return clib_error_return (0, "not found");
1603 vnet_hw_interface_assign_rx_thread (vnm, hw_if_index, queue_id,
1605 vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1611 * This command is used to assign a given interface, and optionally a
1612 * given queue, to a different thread. If the '<em>queue</em>' is not provided,
1613 * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
1614 * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
1617 * Example of how to display the interface placement:
1618 * @cliexstart{show interface rx-placement}
1619 * Thread 1 (vpp_wk_0):
1621 * GigabitEthernet7/0/0 queue 0 (polling)
1622 * node vhost-user-input:
1623 * VirtualEthernet0/0/12 queue 0 (polling)
1624 * VirtualEthernet0/0/12 queue 2 (polling)
1625 * VirtualEthernet0/0/13 queue 0 (polling)
1626 * VirtualEthernet0/0/13 queue 2 (polling)
1627 * Thread 2 (vpp_wk_1):
1629 * GigabitEthernet7/0/1 queue 0 (polling)
1630 * node vhost-user-input:
1631 * VirtualEthernet0/0/12 queue 1 (polling)
1632 * VirtualEthernet0/0/12 queue 3 (polling)
1633 * VirtualEthernet0/0/13 queue 1 (polling)
1634 * VirtualEthernet0/0/13 queue 3 (polling)
1636 * Example of how to assign a interface and queue to a worker thread:
1637 * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
1638 * Example of how to display the interface placement:
1639 * @cliexstart{show interface rx-placement}
1640 * Thread 1 (vpp_wk_0):
1642 * GigabitEthernet7/0/0 queue 0 (polling)
1643 * node vhost-user-input:
1644 * VirtualEthernet0/0/12 queue 0 (polling)
1645 * VirtualEthernet0/0/12 queue 1 (polling)
1646 * VirtualEthernet0/0/12 queue 2 (polling)
1647 * VirtualEthernet0/0/13 queue 0 (polling)
1648 * VirtualEthernet0/0/13 queue 2 (polling)
1649 * Thread 2 (vpp_wk_1):
1651 * GigabitEthernet7/0/1 queue 0 (polling)
1652 * node vhost-user-input:
1653 * VirtualEthernet0/0/12 queue 3 (polling)
1654 * VirtualEthernet0/0/13 queue 1 (polling)
1655 * VirtualEthernet0/0/13 queue 3 (polling)
1659 VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
1660 .path = "set interface rx-placement",
1661 .short_help = "set interface rx-placement <interface> [queue <n>] "
1662 "[worker <n> | main]",
1663 .function = set_interface_rx_placement,
1668 * fd.io coding-style-patch-verification: ON
1671 * eval: (c-set-style "gnu")