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>
55 #include <vnet/classify/vnet_classify.h>
58 compare_interface_names (void *a1, void *a2)
63 return vnet_hw_interface_compare (vnet_get_main (), *hi1, *hi2);
67 show_or_clear_hw_interfaces (vlib_main_t * vm,
68 unformat_input_t * input,
69 vlib_cli_command_t * cmd, int is_show)
71 clib_error_t *error = 0;
72 vnet_main_t *vnm = vnet_get_main ();
73 vnet_interface_main_t *im = &vnm->interface_main;
74 vnet_hw_interface_t *hi;
75 u32 hw_if_index, *hw_if_indices = 0;
76 int i, verbose = -1, show_bond = 0;
78 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
80 /* See if user wants to show a specific interface. */
82 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
83 vec_add1 (hw_if_indices, hw_if_index);
85 /* See if user wants to show an interface with a specific hw_if_index. */
86 else if (unformat (input, "%u", &hw_if_index))
87 vec_add1 (hw_if_indices, hw_if_index);
89 else if (unformat (input, "verbose"))
90 verbose = 1; /* this is also the default */
92 else if (unformat (input, "detail"))
95 else if (unformat (input, "brief"))
98 else if (unformat (input, "bond"))
102 verbose = 0; /* default to brief for link bonding */
107 error = clib_error_return (0, "unknown input `%U'",
108 format_unformat_error, input);
113 /* Gather interfaces. */
114 if (vec_len (hw_if_indices) == 0)
115 pool_foreach (hi, im->hw_interfaces,
116 vec_add1 (hw_if_indices, hi - im->hw_interfaces));
119 verbose = 1; /* default to verbose (except bond) */
124 vec_sort_with_function (hw_if_indices, compare_interface_names);
126 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm, 0, verbose);
127 for (i = 0; i < vec_len (hw_if_indices); i++)
129 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
130 if (show_bond == 0) /* show all interfaces */
131 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
133 else if ((hi->bond_info) &&
134 (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
135 { /* show only bonded interface and all its slave interfaces */
137 vnet_hw_interface_t *shi;
138 vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
142 clib_bitmap_foreach (hw_idx, hi->bond_info,
144 shi = vnet_get_hw_interface(vnm, hw_idx);
145 vlib_cli_output (vm, "%U\n",
146 format_vnet_hw_interface, vnm, shi, verbose);
154 for (i = 0; i < vec_len (hw_if_indices); i++)
156 vnet_device_class_t *dc;
158 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
159 dc = vec_elt_at_index (im->device_classes, hi->dev_class_index);
161 if (dc->clear_counters)
162 dc->clear_counters (hi->dev_instance);
167 vec_free (hw_if_indices);
171 static clib_error_t *
172 show_hw_interfaces (vlib_main_t * vm,
173 unformat_input_t * input, vlib_cli_command_t * cmd)
175 return show_or_clear_hw_interfaces (vm, input, cmd, 1 /* is_show */ );
178 static clib_error_t *
179 clear_hw_interfaces (vlib_main_t * vm,
180 unformat_input_t * input, vlib_cli_command_t * cmd)
182 return show_or_clear_hw_interfaces (vm, input, cmd, 0 /* is_show */ );
187 * Display more detailed information about all or a list of given interfaces.
188 * The verboseness of the output can be controlled by the following optional
190 * - brief: Only show name, index and state (default for bonded interfaces).
191 * - verbose: Also display additional attributes (default for all other interfaces).
192 * - detail: Also display all remaining attributes and extended statistics.
194 * To limit the output of the command to bonded interfaces and their slave
195 * interfaces, use the '<em>bond</em>' optional parameter.
198 * Example of how to display default data for all interfaces:
199 * @cliexstart{show hardware-interfaces}
200 * Name Idx Link Hardware
201 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
202 * Ethernet address ec:f4:bb:c0:bc:fc
204 * carrier up full duplex speed 1000 mtu 9216
205 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
207 * GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
208 * Ethernet address ec:f4:bb:c0:bc:fd
210 * carrier up full duplex speed 1000 mtu 9216
211 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
213 * VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
214 * Ethernet address 02:fe:a5:a9:8b:8e
215 * VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
216 * Ethernet address 02:fe:c0:4e:3b:b0
217 * VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
218 * Ethernet address 02:fe:1f:73:92:81
219 * VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
220 * Ethernet address 02:fe:f2:25:c4:68
221 * local0 0 down local0
224 * Example of how to display '<em>verbose</em>' data for an interface by name and
225 * software index (where 2 is the software index):
226 * @cliexstart{show hardware-interfaces GigabitEthernet7/0/0 2 verbose}
227 * Name Idx Link Hardware
228 * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
229 * Ethernet address ec:f4:bb:c0:bc:fc
231 * carrier up full duplex speed 1000 mtu 9216
232 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
234 * GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
235 * Ethernet address ec:f4:bb:c0:bc:fd
237 * carrier up full duplex speed 1000 mtu 9216
238 * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
243 VLIB_CLI_COMMAND (show_hw_interfaces_command, static) = {
244 .path = "show hardware-interfaces",
245 .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] "
246 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
247 .function = show_hw_interfaces,
253 * Clear the extended statistics for all or a list of given interfaces
254 * (statistics associated with the '<em>show hardware-interfaces</em>' command).
257 * Example of how to clear the extended statistics for all interfaces:
258 * @cliexcmd{clear hardware-interfaces}
259 * Example of how to clear the extended statistics for an interface by
260 * name and software index (where 2 is the software index):
261 * @cliexcmd{clear hardware-interfaces GigabitEthernet7/0/0 2}
264 VLIB_CLI_COMMAND (clear_hw_interface_counters_command, static) = {
265 .path = "clear hardware-interfaces",
266 .short_help = "clear hardware-interfaces "
267 "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
268 .function = clear_hw_interfaces,
273 sw_interface_name_compare (void *a1, void *a2)
275 vnet_sw_interface_t *si1 = a1;
276 vnet_sw_interface_t *si2 = a2;
278 return vnet_sw_interface_compare (vnet_get_main (),
279 si1->sw_if_index, si2->sw_if_index);
282 static clib_error_t *
283 show_sw_interfaces (vlib_main_t * vm,
284 unformat_input_t * input, vlib_cli_command_t * cmd)
286 clib_error_t *error = 0;
287 vnet_main_t *vnm = vnet_get_main ();
288 unformat_input_t _linput, *linput = &_linput;
289 vnet_interface_main_t *im = &vnm->interface_main;
290 vnet_sw_interface_t *si, *sorted_sis = 0;
291 u32 sw_if_index = ~(u32) 0;
292 u8 show_addresses = 0;
293 u8 show_features = 0;
299 * Get a line of input. Won't work if the user typed
300 * "show interface" and nothing more.
302 if (unformat_user (input, unformat_line_input, linput))
304 while (unformat_check_input (linput) != UNFORMAT_END_OF_INPUT)
306 /* See if user wants to show specific interface */
308 (linput, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
310 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
311 vec_add1 (sorted_sis, si[0]);
313 else if (unformat (linput, "address") || unformat (linput, "addr"))
315 else if (unformat (linput, "features") || unformat (linput, "feat"))
317 else if (unformat (linput, "tag"))
319 else if (unformat (linput, "vtr"))
321 else if (unformat (linput, "verbose"))
325 vec_free (sorted_sis);
326 error = clib_error_return (0, "unknown input `%U'",
327 format_unformat_error, linput);
331 unformat_free (linput);
333 if (show_features || show_tag || show_vtr)
335 if (sw_if_index == ~(u32) 0)
337 vec_free (sorted_sis);
338 return clib_error_return (0, "Interface not specified...");
344 vnet_interface_features_show (vm, sw_if_index, verbose);
345 vlib_cli_output (vm, "%U", format_l2_input_features, sw_if_index, 1);
347 l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
348 vlib_cli_output (vm, "\nl2-output:");
349 if (l2_output->out_vtr_flag)
350 vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
351 vlib_cli_output (vm, "%U", format_l2_output_features,
352 l2_output->feature_bitmap, 1);
353 vec_free (sorted_sis);
359 tag = vnet_get_sw_interface_tag (vnm, sw_if_index);
360 vlib_cli_output (vm, "%U: %s",
361 format_vnet_sw_if_index_name, vnm, sw_if_index,
362 tag ? (char *) tag : "(none)");
363 vec_free (sorted_sis);
368 * Show vlan tag rewrite data for one interface.
372 u32 vtr_op = L2_VTR_DISABLED;
373 u32 push_dot1q = 0, tag1 = 0, tag2 = 0;
375 if (l2vtr_get (vm, vnm, sw_if_index,
376 &vtr_op, &push_dot1q, &tag1, &tag2) != 0)
378 vlib_cli_output (vm, "%U: Problem getting vlan tag-rewrite data",
379 format_vnet_sw_if_index_name, vnm, sw_if_index);
382 vlib_cli_output (vm, "%U: VTR %0U",
383 format_vnet_sw_if_index_name, vnm, sw_if_index,
384 format_vtr, vtr_op, push_dot1q, tag1, tag2);
389 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, 0);
391 if (vec_len (sorted_sis) == 0) /* Get all interfaces */
393 /* Gather interfaces. */
395 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
396 _vec_len (sorted_sis) = 0;
398 pool_foreach (si, im->sw_interfaces,
400 int visible = vnet_swif_is_api_visible (si);
402 vec_add1 (sorted_sis, si[0]);}
406 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
411 vec_foreach (si, sorted_sis)
413 ip4_main_t *im4 = &ip4_main;
414 ip6_main_t *im6 = &ip6_main;
415 ip_lookup_main_t *lm4 = &im4->lookup_main;
416 ip_lookup_main_t *lm6 = &im6->lookup_main;
417 ip_interface_address_t *ia = 0;
418 u32 fib_index4 = 0, fib_index6 = 0;
420 if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
421 fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
424 if (vec_len (im6->fib_index_by_sw_if_index) > si->sw_if_index)
425 fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
428 ip4_fib_t *fib4 = ip4_fib_get (fib_index4);
429 ip6_fib_t *fib6 = ip6_fib_get (fib_index6);
431 if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
433 (vm, "%U (%s): \n unnumbered, use %U",
434 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
435 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
436 format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
440 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
441 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn");
443 /* Display any L2 info */
444 vlib_cli_output (vm, "%U", format_l2_input, si->sw_if_index);
447 /* Display any IP4 addressing info */
448 foreach_ip_interface_address (lm4, ia, si->sw_if_index,
449 1 /* honor unnumbered */,
451 ip4_address_t *r4 = ip_interface_address_get_address (lm4, ia);
453 vlib_cli_output (vm, " L3 %U/%d ip4 table-id %d fib-idx %d",
454 format_ip4_address, r4, ia->address_length,
456 ip4_fib_index_from_table_id (fib4->table_id));
458 vlib_cli_output (vm, " L3 %U/%d",
459 format_ip4_address, r4, ia->address_length);
464 /* Display any IP6 addressing info */
465 foreach_ip_interface_address (lm6, ia, si->sw_if_index,
466 1 /* honor unnumbered */,
468 ip6_address_t *r6 = ip_interface_address_get_address (lm6, ia);
470 vlib_cli_output (vm, " L3 %U/%d ip6 table-id %d fib-idx %d",
471 format_ip6_address, r6, ia->address_length,
473 ip6_fib_index_from_table_id (fib6->table_id));
475 vlib_cli_output (vm, " L3 %U/%d",
476 format_ip6_address, r6, ia->address_length);
483 vec_foreach (si, sorted_sis)
485 vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, si);
490 vec_free (sorted_sis);
495 VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
496 .path = "show interface",
497 .short_help = "show interface [address|addr|features|feat|vtr] [<interface> [<interface> [..]]] [verbose]",
498 .function = show_sw_interfaces,
503 /* Root of all interface commands. */
505 VLIB_CLI_COMMAND (vnet_cli_interface_command, static) = {
507 .short_help = "Interface commands",
512 VLIB_CLI_COMMAND (vnet_cli_set_interface_command, static) = {
513 .path = "set interface",
514 .short_help = "Interface commands",
518 static clib_error_t *
519 clear_interface_counters (vlib_main_t * vm,
520 unformat_input_t * input, vlib_cli_command_t * cmd)
522 vnet_main_t *vnm = vnet_get_main ();
523 vnet_interface_main_t *im = &vnm->interface_main;
524 vlib_simple_counter_main_t *sm;
525 vlib_combined_counter_main_t *cm;
528 n_counters = vec_len (im->combined_sw_if_counters);
530 for (j = 0; j < n_counters; j++)
532 im = &vnm->interface_main;
533 cm = im->combined_sw_if_counters + j;
534 vlib_clear_combined_counters (cm);
537 n_counters = vec_len (im->sw_if_counters);
539 for (j = 0; j < n_counters; j++)
541 im = &vnm->interface_main;
542 sm = im->sw_if_counters + j;
543 vlib_clear_simple_counters (sm);
550 * Clear the statistics for all interfaces (statistics associated with the
551 * '<em>show interface</em>' command).
554 * Example of how to clear the statistics for all interfaces:
555 * @cliexcmd{clear interfaces}
558 VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
559 .path = "clear interfaces",
560 .short_help = "clear interfaces",
561 .function = clear_interface_counters,
566 * Parse subinterface names.
568 * The following subinterface syntax is supported. The first two are for
569 * backwards compatability:
572 * - a subinterface with the name <intf-name>.<id>. The subinterface
573 * is a single dot1q vlan with vlan id <id> and exact-match semantics.
575 * <intf-name> <min_id>-<max_id>
576 * - a set of the above subinterfaces, repeating for each id
577 * in the range <min_id> to <max_id>
579 * In the following, exact-match semantics (i.e. the number of vlan tags on the
580 * packet must match the number of tags in the configuration) are used only if
581 * the keyword exact-match is present. Non-exact match is the default.
583 * <intf-name> <id> dot1q <outer_id> [exact-match]
584 * - a subinterface with the name <intf-name>.<id>. The subinterface
585 * is a single dot1q vlan with vlan id <outer_id>.
587 * <intf-name> <id> dot1q any [exact-match]
588 * - a subinterface with the name <intf-name>.<id>. The subinterface
589 * is a single dot1q vlan with any vlan id.
591 * <intf-name> <id> dot1q <outer_id> inner-dot1q <inner_id> [exact-match]
592 * - a subinterface with the name <intf-name>.<id>. The subinterface
593 * is a double dot1q vlan with outer vlan id <outer_id> and inner vlan id
596 * <intf-name> <id> dot1q <outer_id> inner-dot1q any [exact-match]
597 * - a subinterface with the name <intf-name>.<id>. The subinterface
598 * is a double dot1q vlan with outer vlan id <id> and any inner vlan id.
600 * <intf-name> <id> dot1q any inner-dot1q any [exact-match]
602 * - a subinterface with the name <intf-name>.<id>. The subinterface
603 * is a double dot1q vlan with any outer vlan id and any inner vlan id.
605 * For each of the above CLI, there is a duplicate that uses the keyword
606 * "dot1ad" in place of the first "dot1q". These interfaces use ethertype
607 * 0x88ad in place of 0x8100 for the outer ethertype. Note that for double-
608 * tagged packets the inner ethertype is always 0x8100. Also note that
609 * the dot1q and dot1ad naming spaces are independent, so it is legal to
610 * have both "Gig3/0/0.1 dot1q 100" and "Gig3/0/0.2 dot1ad 100". For example:
612 * <intf-name> <id> dot1ad <outer_id> inner-dot1q <inner_id> [exact-match]
613 * - a subinterface with the name <intf-name>.<id>. The subinterface
614 * is a double dot1ad vlan with outer vlan id <outer_id> and inner vlan
617 * <intf-name> <id> untagged
618 * - a subinterface with the name <intf-name>.<id>. The subinterface
619 * has no vlan tags. Only one can be specified per interface.
621 * <intf-name> <id> default
622 * - a subinterface with the name <intf-name>.<id>. This is associated
623 * with a packet that did not match any other configured subinterface
624 * on this interface. Only one can be specified per interface.
627 static clib_error_t *
628 parse_vlan_sub_interfaces (unformat_input_t * input,
629 vnet_sw_interface_t * template)
631 clib_error_t *error = 0;
632 u32 inner_vlan, outer_vlan;
634 if (unformat (input, "any inner-dot1q any"))
636 template->sub.eth.flags.two_tags = 1;
637 template->sub.eth.flags.outer_vlan_id_any = 1;
638 template->sub.eth.flags.inner_vlan_id_any = 1;
640 else if (unformat (input, "any"))
642 template->sub.eth.flags.one_tag = 1;
643 template->sub.eth.flags.outer_vlan_id_any = 1;
645 else if (unformat (input, "%d inner-dot1q any", &outer_vlan))
647 template->sub.eth.flags.two_tags = 1;
648 template->sub.eth.flags.inner_vlan_id_any = 1;
649 template->sub.eth.outer_vlan_id = outer_vlan;
651 else if (unformat (input, "%d inner-dot1q %d", &outer_vlan, &inner_vlan))
653 template->sub.eth.flags.two_tags = 1;
654 template->sub.eth.outer_vlan_id = outer_vlan;
655 template->sub.eth.inner_vlan_id = inner_vlan;
657 else if (unformat (input, "%d", &outer_vlan))
659 template->sub.eth.flags.one_tag = 1;
660 template->sub.eth.outer_vlan_id = outer_vlan;
664 error = clib_error_return (0, "expected dot1q config, got `%U'",
665 format_unformat_error, input);
669 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
671 if (unformat (input, "exact-match"))
673 template->sub.eth.flags.exact_match = 1;
681 static clib_error_t *
682 create_sub_interfaces (vlib_main_t * vm,
683 unformat_input_t * input, vlib_cli_command_t * cmd)
685 vnet_main_t *vnm = vnet_get_main ();
686 clib_error_t *error = 0;
687 u32 hw_if_index, sw_if_index;
688 vnet_hw_interface_t *hi;
689 u32 id, id_min, id_max;
690 vnet_sw_interface_t template;
693 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
695 error = clib_error_return (0, "unknown interface `%U'",
696 format_unformat_error, input);
700 clib_memset (&template, 0, sizeof (template));
701 template.sub.eth.raw_flags = 0;
703 if (unformat (input, "%d default", &id_min))
706 template.sub.eth.flags.default_sub = 1;
708 else if (unformat (input, "%d untagged", &id_min))
711 template.sub.eth.flags.no_tags = 1;
712 template.sub.eth.flags.exact_match = 1;
714 else if (unformat (input, "%d dot1q", &id_min))
716 /* parse dot1q config */
718 error = parse_vlan_sub_interfaces (input, &template);
722 else if (unformat (input, "%d dot1ad", &id_min))
724 /* parse dot1ad config */
726 template.sub.eth.flags.dot1ad = 1;
727 error = parse_vlan_sub_interfaces (input, &template);
731 else if (unformat (input, "%d-%d", &id_min, &id_max))
733 template.sub.eth.flags.one_tag = 1;
734 template.sub.eth.flags.exact_match = 1;
738 else if (unformat (input, "%d", &id_min))
741 template.sub.eth.flags.one_tag = 1;
742 template.sub.eth.outer_vlan_id = id_min;
743 template.sub.eth.flags.exact_match = 1;
748 error = clib_error_return (0, "expected ID or ID MIN-MAX, got `%U'",
749 format_unformat_error, input);
753 hi = vnet_get_hw_interface (vnm, hw_if_index);
755 if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
758 clib_error_return (0,
759 "not allowed as %v belong to a BondEthernet interface",
764 for (id = id_min; id <= id_max; id++)
767 vnet_interface_main_t *im = &vnm->interface_main;
768 u64 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
771 p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
775 clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
776 hi->sw_if_index, id);
780 template.type = VNET_SW_INTERFACE_TYPE_SUB;
781 template.flood_class = VNET_FLOOD_CLASS_NORMAL;
782 template.sup_sw_if_index = hi->sw_if_index;
783 template.sub.id = id;
785 template.sub.eth.outer_vlan_id = id;
787 error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
791 kp = clib_mem_alloc (sizeof (*kp));
792 *kp = sup_and_sub_key;
794 hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
795 hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
796 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
797 vnet_get_main (), sw_if_index);
805 * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
806 * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
807 * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
808 * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
809 * but this is not recommended.
811 * This command has several variations:
812 * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
813 * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
815 * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
816 * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
817 * match any other subinterfaces should be sent to this subinterface.
819 * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
820 * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
821 * to this subinterface.
823 * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
824 * subinterfaces to handle a range of VLAN IDs.
826 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
827 * Use this command to specify the outer VLAN ID, to either be explicit or to make the
828 * VLAN ID different from the '<em>subId</em>'.
830 * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
831 * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
834 * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explicitly entered, subinterfaces
835 * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
836 * default. If '<em>exact-match</em>' is specified, packets must have the same number of
837 * VLAN tags as the configuration. For non-exact-match, packets must at least that number
838 * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
839 * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
840 * entered, then the default behavior is exact-match.
842 * Use the '<em>show interface</em>' command to display all subinterfaces.
846 * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
847 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
849 * The previous example is shorthand and is equivalent to:
850 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
853 * Example of how to create a subinterface number that is different from the VLAN ID:
854 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
857 * Examples of how to create q-in-q and q-in-any subinterfaces:
858 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
859 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
861 * Examples of how to create dot1ad interfaces:
862 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
863 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
866 * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
867 * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
868 * is non-exact match:
869 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
871 * However, the same packet would NOT match this interface because '<em>exact-match</em>'
872 * is specified and only one VLAN is configured, but packet contains two VLANs:
873 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
876 * Example of how to created a subinterface to process untagged packets:
877 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
879 * Example of how to created a subinterface to process any packet with a VLAN ID that
880 * does not match any other subinterface:
881 * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
883 * When subinterfaces are created, they are in the down state. Example of how to
884 * enable a newly created subinterface:
885 * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
889 VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
890 .path = "create sub-interfaces",
891 .short_help = "create sub-interfaces <interface> "
892 "{<subId> [default|untagged]} | "
893 "{<subId>-<subId>} | "
894 "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
895 .function = create_sub_interfaces,
899 static clib_error_t *
900 set_state (vlib_main_t * vm,
901 unformat_input_t * input, vlib_cli_command_t * cmd)
903 vnet_main_t *vnm = vnet_get_main ();
905 u32 sw_if_index, flags;
908 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
910 error = clib_error_return (0, "unknown interface `%U'",
911 format_unformat_error, input);
915 if (!unformat (input, "%U", unformat_vnet_sw_interface_flags, &flags))
917 error = clib_error_return (0, "unknown flags `%U'",
918 format_unformat_error, input);
922 error = vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
932 * This command is used to change the admin state (up/down) of an interface.
934 * If an interface is down, the optional '<em>punt</em>' flag can also be set.
935 * The '<em>punt</em>' flag implies the interface is disabled for forwarding
936 * but punt all traffic to slow-path. Use the '<em>enable</em>' flag to clear
937 * '<em>punt</em>' flag (interface is still down).
940 * Example of how to configure the admin state of an interface to '<em>up</em?':
941 * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
942 * Example of how to configure the admin state of an interface to '<em>down</em?':
943 * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
946 VLIB_CLI_COMMAND (set_state_command, static) = {
947 .path = "set interface state",
948 .short_help = "set interface state <interface> [up|down|punt|enable]",
949 .function = set_state,
953 static clib_error_t *
954 set_unnumbered (vlib_main_t * vm,
955 unformat_input_t * input, vlib_cli_command_t * cmd)
957 vnet_main_t *vnm = vnet_get_main ();
958 u32 unnumbered_sw_if_index = ~0;
959 u32 inherit_from_sw_if_index = ~0;
962 if (unformat (input, "%U use %U",
963 unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
964 unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
966 else if (unformat (input, "del %U",
967 unformat_vnet_sw_interface, vnm,
968 &unnumbered_sw_if_index))
971 return clib_error_return (0, "parse error '%U'",
972 format_unformat_error, input);
974 if (~0 == unnumbered_sw_if_index)
975 return clib_error_return (0, "Specify the unnumbered interface");
976 if (enable && ~0 == inherit_from_sw_if_index)
977 return clib_error_return (0, "When enabling unnumbered specify the"
978 " IP enabled interface that it uses");
980 vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
981 inherit_from_sw_if_index, enable);
987 VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
988 .path = "set interface unnumbered",
989 .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
990 .function = set_unnumbered,
996 static clib_error_t *
997 set_hw_class (vlib_main_t * vm,
998 unformat_input_t * input, vlib_cli_command_t * cmd)
1000 vnet_main_t *vnm = vnet_get_main ();
1001 vnet_interface_main_t *im = &vnm->interface_main;
1002 clib_error_t *error;
1003 u32 hw_if_index, hw_class_index;
1006 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1008 error = clib_error_return (0, "unknown hardware interface `%U'",
1009 format_unformat_error, input);
1013 if (!unformat_user (input, unformat_hash_string,
1014 im->hw_interface_class_by_name, &hw_class_index))
1016 error = clib_error_return (0, "unknown hardware class `%U'",
1017 format_unformat_error, input);
1021 error = vnet_hw_interface_set_class (vnm, hw_if_index, hw_class_index);
1030 VLIB_CLI_COMMAND (set_hw_class_command, static) = {
1031 .path = "set interface hw-class",
1032 .short_help = "Set interface hardware class",
1033 .function = set_hw_class,
1037 static clib_error_t *
1038 vnet_interface_cli_init (vlib_main_t * vm)
1043 VLIB_INIT_FUNCTION (vnet_interface_cli_init);
1045 static clib_error_t *
1046 renumber_interface_command_fn (vlib_main_t * vm,
1047 unformat_input_t * input,
1048 vlib_cli_command_t * cmd)
1051 u32 new_dev_instance;
1052 vnet_main_t *vnm = vnet_get_main ();
1055 if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1056 return clib_error_return (0, "unknown hardware interface `%U'",
1057 format_unformat_error, input);
1059 if (!unformat (input, "%d", &new_dev_instance))
1060 return clib_error_return (0, "new dev instance missing");
1062 rv = vnet_interface_name_renumber (hw_if_index, new_dev_instance);
1070 return clib_error_return (0, "vnet_interface_name_renumber returned %d",
1080 VLIB_CLI_COMMAND (renumber_interface_command, static) = {
1081 .path = "renumber interface",
1082 .short_help = "renumber interface <interface> <new-dev-instance>",
1083 .function = renumber_interface_command_fn,
1087 static clib_error_t *
1088 promiscuous_cmd (vlib_main_t * vm,
1089 unformat_input_t * input, vlib_cli_command_t * cmd)
1091 vnet_main_t *vnm = vnet_get_main ();
1093 u32 flags = ETHERNET_INTERFACE_FLAG_ACCEPT_ALL;
1094 ethernet_main_t *em = ðernet_main;
1095 ethernet_interface_t *eif;
1097 if (unformat (input, "on %U",
1098 unformat_vnet_hw_interface, vnm, &hw_if_index))
1100 else if (unformat (input, "off %U",
1101 unformat_ethernet_interface, vnm, &hw_if_index))
1104 return clib_error_return (0, "unknown input `%U'",
1105 format_unformat_error, input);
1107 eif = ethernet_get_interface (em, hw_if_index);
1109 return clib_error_return (0, "not supported");
1111 ethernet_set_flags (vnm, hw_if_index, flags);
1116 VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
1117 .path = "set interface promiscuous",
1118 .short_help = "set interface promiscuous [on|off] <interface>",
1119 .function = promiscuous_cmd,
1123 static clib_error_t *
1124 mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1126 vnet_main_t *vnm = vnet_get_main ();
1127 u32 hw_if_index, sw_if_index, mtu;
1128 ethernet_main_t *em = ðernet_main;
1129 u32 mtus[VNET_N_MTU] = { 0, 0, 0, 0 };
1131 if (unformat (input, "%d %U", &mtu,
1132 unformat_vnet_hw_interface, vnm, &hw_if_index))
1135 * Change physical MTU on interface. Only supported for Ethernet
1138 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1139 ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
1142 return clib_error_return (0, "not supported");
1144 if (mtu < hi->min_supported_packet_bytes)
1145 return clib_error_return (0, "Invalid mtu (%d): "
1146 "must be >= min pkt bytes (%d)", mtu,
1147 hi->min_supported_packet_bytes);
1149 if (mtu > hi->max_supported_packet_bytes)
1150 return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
1151 hi->max_supported_packet_bytes);
1153 vnet_hw_interface_set_mtu (vnm, hw_if_index, mtu);
1156 else if (unformat (input, "packet %d %U", &mtu,
1157 unformat_vnet_sw_interface, vnm, &sw_if_index))
1158 /* Set default packet MTU (including L3 header */
1159 mtus[VNET_MTU_L3] = mtu;
1160 else if (unformat (input, "ip4 %d %U", &mtu,
1161 unformat_vnet_sw_interface, vnm, &sw_if_index))
1162 mtus[VNET_MTU_IP4] = mtu;
1163 else if (unformat (input, "ip6 %d %U", &mtu,
1164 unformat_vnet_sw_interface, vnm, &sw_if_index))
1165 mtus[VNET_MTU_IP6] = mtu;
1166 else if (unformat (input, "mpls %d %U", &mtu,
1167 unformat_vnet_sw_interface, vnm, &sw_if_index))
1168 mtus[VNET_MTU_MPLS] = mtu;
1170 return clib_error_return (0, "unknown input `%U'",
1171 format_unformat_error, input);
1173 vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, mtus);
1180 VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
1181 .path = "set interface mtu",
1182 .short_help = "set interface mtu [packet|ip4|ip6|mpls] <value> <interface>",
1183 .function = mtu_cmd,
1187 static clib_error_t *
1188 show_interface_sec_mac_addr_fn (vlib_main_t * vm, unformat_input_t * input,
1189 vlib_cli_command_t * cmd)
1191 vnet_main_t *vnm = vnet_get_main ();
1192 vnet_interface_main_t *im = &vnm->interface_main;
1193 ethernet_main_t *em = ðernet_main;
1194 u32 sw_if_index = ~0;
1195 vnet_sw_interface_t *si, *sorted_sis = 0;
1197 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1199 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
1200 vec_add1 (sorted_sis, si[0]);
1203 /* if an interface name was not passed, get all interfaces */
1204 if (vec_len (sorted_sis) == 0)
1207 vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1208 _vec_len (sorted_sis) = 0;
1210 pool_foreach (si, im->sw_interfaces,
1212 int visible = vnet_swif_is_api_visible (si);
1214 vec_add1 (sorted_sis, si[0]);}
1218 vec_sort_with_function (sorted_sis, sw_interface_name_compare);
1221 vec_foreach (si, sorted_sis)
1223 vnet_sw_interface_t *sup_si;
1224 ethernet_interface_t *ei;
1226 sup_si = vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1227 ei = ethernet_get_interface (em, sup_si->hw_if_index);
1229 vlib_cli_output (vm, "%U (%s):",
1230 format_vnet_sw_if_index_name, vnm, si->sw_if_index,
1231 (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
1234 if (ei && ei->secondary_addrs)
1236 mac_address_t *sec_addr;
1238 vec_foreach (sec_addr, ei->secondary_addrs)
1240 vlib_cli_output (vm, " %U", format_mac_address_t, sec_addr);
1245 vec_free (sorted_sis);
1250 * This command is used to display interface secondary mac addresses.
1253 * Example of how to display interface secondary mac addresses:
1254 * @cliexstart{show interface secondary-mac-address}
1258 VLIB_CLI_COMMAND (show_interface_sec_mac_addr, static) = {
1259 .path = "show interface secondary-mac-address",
1260 .short_help = "show interface secondary-mac-address [<interface>]",
1261 .function = show_interface_sec_mac_addr_fn,
1265 static clib_error_t *
1266 interface_add_del_mac_address (vlib_main_t * vm, unformat_input_t * input,
1267 vlib_cli_command_t * cmd)
1269 vnet_main_t *vnm = vnet_get_main ();
1270 vnet_sw_interface_t *si = NULL;
1271 clib_error_t *error = 0;
1272 u32 sw_if_index = ~0;
1276 is_add = is_del = 0;
1278 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1280 error = clib_error_return (0, "unknown interface `%U'",
1281 format_unformat_error, input);
1284 if (!unformat_user (input, unformat_ethernet_address, mac))
1286 error = clib_error_return (0, "expected mac address `%U'",
1287 format_unformat_error, input);
1291 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1293 if (unformat (input, "add"))
1295 else if (unformat (input, "del"))
1301 if (is_add == is_del)
1303 error = clib_error_return (0, "must choose one of add or del");
1307 si = vnet_get_sw_interface (vnm, sw_if_index);
1309 vnet_hw_interface_add_del_mac_address (vnm, si->hw_if_index, mac, is_add);
1316 * The '<em>set interface secondary-mac-address </em>' command allows adding
1317 * or deleting extra MAC addresses on a given interface without changing the
1318 * default MAC address. This could allow packets sent to these MAC addresses
1319 * to be received without setting the interface to promiscuous mode.
1320 * Not all interfaces support this operation. The ones that do are mostly
1321 * hardware NICs, though virtio does also.
1325 * Example of how to add a secondary MAC Address on an interface:
1326 * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 add}
1327 * Example of how to delete a secondary MAC address from an interface:
1328 * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 del}
1332 VLIB_CLI_COMMAND (interface_add_del_mac_address_cmd, static) = {
1333 .path = "set interface secondary-mac-address",
1334 .short_help = "set interface secondary-mac-address <interface> <mac-address> [(add|del)]",
1335 .function = interface_add_del_mac_address,
1339 static clib_error_t *
1340 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
1341 vlib_cli_command_t * cmd)
1343 vnet_main_t *vnm = vnet_get_main ();
1344 vnet_sw_interface_t *si = NULL;
1345 clib_error_t *error = 0;
1346 u32 sw_if_index = ~0;
1349 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1351 error = clib_error_return (0, "unknown interface `%U'",
1352 format_unformat_error, input);
1355 if (!unformat_user (input, unformat_ethernet_address, mac))
1357 error = clib_error_return (0, "expected mac address `%U'",
1358 format_unformat_error, input);
1361 si = vnet_get_sw_interface (vnm, sw_if_index);
1362 error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
1368 * The '<em>set interface mac address </em>' command allows to set MAC address of given interface.
1369 * In case of NIC interfaces the one has to support MAC address change. A side effect of MAC address
1370 * change are changes of MAC addresses in FIB tables (ipv4 and ipv6).
1374 * Example of how to change MAC Address of interface:
1375 * @cliexcmd{set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01}
1376 * @cliexcmd{set interface mac address host-vpp0 aa:bb:cc:dd:ee:02}
1377 * @cliexcmd{set interface mac address tap-0 aa:bb:cc:dd:ee:03}
1378 * @cliexcmd{set interface mac address pg0 aa:bb:cc:dd:ee:04}
1382 VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
1383 .path = "set interface mac address",
1384 .short_help = "set interface mac address <interface> <mac-address>",
1385 .function = set_interface_mac_address,
1389 static clib_error_t *
1390 set_tag (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1392 vnet_main_t *vnm = vnet_get_main ();
1393 u32 sw_if_index = ~0;
1396 if (!unformat (input, "%U %s", unformat_vnet_sw_interface,
1397 vnm, &sw_if_index, &tag))
1398 return clib_error_return (0, "unknown input `%U'",
1399 format_unformat_error, input);
1401 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
1407 VLIB_CLI_COMMAND (set_tag_command, static) = {
1408 .path = "set interface tag",
1409 .short_help = "set interface tag <interface> <tag>",
1410 .function = set_tag,
1414 static clib_error_t *
1415 clear_tag (vlib_main_t * vm, unformat_input_t * input,
1416 vlib_cli_command_t * cmd)
1418 vnet_main_t *vnm = vnet_get_main ();
1419 u32 sw_if_index = ~0;
1421 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1422 return clib_error_return (0, "unknown input `%U'",
1423 format_unformat_error, input);
1425 vnet_clear_sw_interface_tag (vnm, sw_if_index);
1431 VLIB_CLI_COMMAND (clear_tag_command, static) = {
1432 .path = "clear interface tag",
1433 .short_help = "clear interface tag <interface>",
1434 .function = clear_tag,
1438 static clib_error_t *
1439 set_ip_directed_broadcast (vlib_main_t * vm,
1440 unformat_input_t * input, vlib_cli_command_t * cmd)
1442 vnet_main_t *vnm = vnet_get_main ();
1443 u32 sw_if_index = ~0;
1446 if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index));
1447 else if (unformat (input, "enable"))
1449 else if (unformat (input, "disable"))
1452 return clib_error_return (0, "unknown input: `%U'",
1453 format_unformat_error, input);
1455 if (~0 == sw_if_index)
1456 return clib_error_return (0, "specify an interface: `%U'",
1457 format_unformat_error, input);
1459 vnet_sw_interface_ip_directed_broadcast (vnm, sw_if_index, enable);
1465 * This command is used to enable/disable IP directed broadcast
1466 * If directed broadcast is enabled a packet sent to the interface's
1467 * subnet broadcast address will be sent L2 broadcast on the interface,
1468 * otherwise it is dropped.
1471 VLIB_CLI_COMMAND (set_ip_directed_broadcast_command, static) = {
1472 .path = "set interface ip directed-broadcast",
1473 .short_help = "set interface enable <interface> <enable|disable>",
1474 .function = set_ip_directed_broadcast,
1478 static clib_error_t *
1479 set_hw_interface_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1480 u32 queue_id, vnet_hw_if_rx_mode mode)
1482 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1483 vnet_device_class_t *dev_class =
1484 vnet_get_device_class (vnm, hw->dev_class_index);
1485 clib_error_t *error;
1486 vnet_hw_if_rx_mode old_mode;
1489 if (mode == VNET_HW_IF_RX_MODE_DEFAULT)
1490 mode = hw->default_rx_mode;
1492 rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &old_mode);
1496 if (old_mode == mode)
1497 return 0; /* same rx-mode, no change */
1499 case VNET_API_ERROR_INVALID_INTERFACE:
1500 return clib_error_return (0, "invalid interface");
1501 case VNET_API_ERROR_INVALID_QUEUE:
1502 return clib_error_return (0, "invalid queue");
1504 return clib_error_return (0, "unknown error");
1507 if (dev_class->rx_mode_change_function)
1509 error = dev_class->rx_mode_change_function (vnm, hw_if_index, queue_id,
1515 rv = vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1520 case VNET_API_ERROR_UNSUPPORTED:
1521 return clib_error_return (0, "unsupported");
1522 case VNET_API_ERROR_INVALID_INTERFACE:
1523 return clib_error_return (0, "invalid interface");
1524 case VNET_API_ERROR_INVALID_QUEUE:
1525 return clib_error_return (0, "invalid queue");
1527 return clib_error_return (0, "unknown error");
1534 set_hw_interface_change_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1535 u8 queue_id_valid, u32 queue_id,
1536 vnet_hw_if_rx_mode mode)
1538 clib_error_t *error = 0;
1539 vnet_hw_interface_t *hw;
1542 hw = vnet_get_hw_interface (vnm, hw_if_index);
1544 if (queue_id_valid == 0)
1546 for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1548 error = set_hw_interface_rx_mode (vnm, hw_if_index, i, mode);
1552 hw->default_rx_mode = mode;
1555 error = set_hw_interface_rx_mode (vnm, hw_if_index, queue_id, mode);
1560 static clib_error_t *
1561 set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
1562 vlib_cli_command_t * cmd)
1564 clib_error_t *error = 0;
1565 unformat_input_t _line_input, *line_input = &_line_input;
1566 vnet_main_t *vnm = vnet_get_main ();
1567 u32 hw_if_index = (u32) ~ 0;
1568 u32 queue_id = (u32) ~ 0;
1569 vnet_hw_if_rx_mode mode = VNET_HW_IF_RX_MODE_UNKNOWN;
1570 u8 queue_id_valid = 0;
1572 if (!unformat_user (input, unformat_line_input, line_input))
1575 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1578 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1580 else if (unformat (line_input, "queue %d", &queue_id))
1582 else if (unformat (line_input, "polling"))
1583 mode = VNET_HW_IF_RX_MODE_POLLING;
1584 else if (unformat (line_input, "interrupt"))
1585 mode = VNET_HW_IF_RX_MODE_INTERRUPT;
1586 else if (unformat (line_input, "adaptive"))
1587 mode = VNET_HW_IF_RX_MODE_ADAPTIVE;
1590 error = clib_error_return (0, "parse error: '%U'",
1591 format_unformat_error, line_input);
1592 unformat_free (line_input);
1597 unformat_free (line_input);
1599 if (hw_if_index == (u32) ~ 0)
1600 return clib_error_return (0, "please specify valid interface name");
1602 if (mode == VNET_HW_IF_RX_MODE_UNKNOWN)
1603 return clib_error_return (0, "please specify valid rx-mode");
1605 error = set_hw_interface_change_rx_mode (vnm, hw_if_index, queue_id_valid,
1612 * This command is used to assign the RX packet processing mode (polling,
1613 * interrupt, adaptive) of the a given interface, and optionally a
1614 * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
1615 * is applied to all queues of the interface. Not all interfaces support
1616 * all modes. To display the current rx-mode use the command
1617 * '<em>show interface rx-placement</em>'.
1620 * Example of how to assign rx-mode to all queues on an interface:
1621 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
1622 * Example of how to assign rx-mode to one queue of an interface:
1623 * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
1624 * Example of how to display the rx-mode of all interfaces:
1625 * @cliexstart{show interface rx-placement}
1626 * Thread 1 (vpp_wk_0):
1628 * GigabitEthernet7/0/0 queue 0 (polling)
1629 * node vhost-user-input:
1630 * VirtualEthernet0/0/12 queue 0 (interrupt)
1631 * VirtualEthernet0/0/12 queue 2 (polling)
1632 * VirtualEthernet0/0/13 queue 0 (polling)
1633 * VirtualEthernet0/0/13 queue 2 (polling)
1634 * Thread 2 (vpp_wk_1):
1636 * GigabitEthernet7/0/1 queue 0 (polling)
1637 * node vhost-user-input:
1638 * VirtualEthernet0/0/12 queue 1 (polling)
1639 * VirtualEthernet0/0/12 queue 3 (polling)
1640 * VirtualEthernet0/0/13 queue 1 (polling)
1641 * VirtualEthernet0/0/13 queue 3 (polling)
1645 VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
1646 .path = "set interface rx-mode",
1647 .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
1648 .function = set_interface_rx_mode,
1652 static clib_error_t *
1653 show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
1654 vlib_cli_command_t * cmd)
1657 vnet_main_t *vnm = vnet_get_main ();
1658 vnet_device_input_runtime_t *rt;
1659 vnet_device_and_queue_t *dq;
1660 vlib_node_t *pn = vlib_get_node_by_name (vm, (u8 *) "device-input");
1665 foreach_vlib_main (({
1666 clib_bitmap_foreach (si, pn->sibling_bitmap,
1668 rt = vlib_node_get_runtime_data (this_vlib_main, si);
1670 if (vec_len (rt->devices_and_queues))
1671 s = format (s, " node %U:\n", format_vlib_node_name, vm, si);
1673 vec_foreach (dq, rt->devices_and_queues)
1675 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm,
1677 s = format (s, " %U queue %u (%U)\n",
1678 format_vnet_sw_if_index_name, vnm, hi->sw_if_index,
1680 format_vnet_hw_if_rx_mode, dq->mode);
1683 if (vec_len (s) > 0)
1685 vlib_cli_output(vm, "Thread %u (%s):\n%v", index,
1686 vlib_worker_threads[index].name, s);
1687 vec_reset_length (s);
1698 * This command is used to display the interface and queue worker
1702 * Example of how to display the interface placement:
1703 * @cliexstart{show interface rx-placement}
1704 * Thread 1 (vpp_wk_0):
1706 * GigabitEthernet7/0/0 queue 0 (polling)
1707 * node vhost-user-input:
1708 * VirtualEthernet0/0/12 queue 0 (polling)
1709 * VirtualEthernet0/0/12 queue 2 (polling)
1710 * VirtualEthernet0/0/13 queue 0 (polling)
1711 * VirtualEthernet0/0/13 queue 2 (polling)
1712 * Thread 2 (vpp_wk_1):
1714 * GigabitEthernet7/0/1 queue 0 (polling)
1715 * node vhost-user-input:
1716 * VirtualEthernet0/0/12 queue 1 (polling)
1717 * VirtualEthernet0/0/12 queue 3 (polling)
1718 * VirtualEthernet0/0/13 queue 1 (polling)
1719 * VirtualEthernet0/0/13 queue 3 (polling)
1723 VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
1724 .path = "show interface rx-placement",
1725 .short_help = "show interface rx-placement",
1726 .function = show_interface_rx_placement_fn,
1731 set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
1732 u32 thread_index, u8 is_main)
1734 vnet_main_t *vnm = vnet_get_main ();
1735 vnet_device_main_t *vdm = &vnet_device_main;
1736 clib_error_t *error = 0;
1737 vnet_hw_if_rx_mode mode = VNET_HW_IF_RX_MODE_UNKNOWN;
1743 thread_index += vdm->first_worker_thread_index;
1745 if (thread_index > vdm->last_worker_thread_index)
1746 return clib_error_return (0,
1747 "please specify valid worker thread or main");
1749 rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &mode);
1752 return clib_error_return (0, "not found");
1754 rv = vnet_hw_interface_unassign_rx_thread (vnm, hw_if_index, queue_id);
1757 return clib_error_return (0, "not found");
1759 vnet_hw_interface_assign_rx_thread (vnm, hw_if_index, queue_id,
1761 vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1766 static clib_error_t *
1767 set_interface_rx_placement (vlib_main_t * vm, unformat_input_t * input,
1768 vlib_cli_command_t * cmd)
1770 clib_error_t *error = 0;
1771 unformat_input_t _line_input, *line_input = &_line_input;
1772 vnet_main_t *vnm = vnet_get_main ();
1773 u32 hw_if_index = (u32) ~ 0;
1774 u32 queue_id = (u32) 0;
1775 u32 thread_index = (u32) ~ 0;
1778 if (!unformat_user (input, unformat_line_input, line_input))
1781 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1784 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1786 else if (unformat (line_input, "queue %d", &queue_id))
1788 else if (unformat (line_input, "main", &thread_index))
1790 else if (unformat (line_input, "worker %d", &thread_index))
1794 error = clib_error_return (0, "parse error: '%U'",
1795 format_unformat_error, line_input);
1796 unformat_free (line_input);
1801 unformat_free (line_input);
1803 if (hw_if_index == (u32) ~ 0)
1804 return clib_error_return (0, "please specify valid interface name");
1806 error = set_hw_interface_rx_placement (hw_if_index, queue_id, thread_index,
1813 * This command is used to assign a given interface, and optionally a
1814 * given queue, to a different thread. If the '<em>queue</em>' is not provided,
1815 * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
1816 * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
1819 * Example of how to display the interface placement:
1820 * @cliexstart{show interface rx-placement}
1821 * Thread 1 (vpp_wk_0):
1823 * GigabitEthernet7/0/0 queue 0 (polling)
1824 * node vhost-user-input:
1825 * VirtualEthernet0/0/12 queue 0 (polling)
1826 * VirtualEthernet0/0/12 queue 2 (polling)
1827 * VirtualEthernet0/0/13 queue 0 (polling)
1828 * VirtualEthernet0/0/13 queue 2 (polling)
1829 * Thread 2 (vpp_wk_1):
1831 * GigabitEthernet7/0/1 queue 0 (polling)
1832 * node vhost-user-input:
1833 * VirtualEthernet0/0/12 queue 1 (polling)
1834 * VirtualEthernet0/0/12 queue 3 (polling)
1835 * VirtualEthernet0/0/13 queue 1 (polling)
1836 * VirtualEthernet0/0/13 queue 3 (polling)
1838 * Example of how to assign a interface and queue to a worker thread:
1839 * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
1840 * Example of how to display the interface placement:
1841 * @cliexstart{show interface rx-placement}
1842 * Thread 1 (vpp_wk_0):
1844 * GigabitEthernet7/0/0 queue 0 (polling)
1845 * node vhost-user-input:
1846 * VirtualEthernet0/0/12 queue 0 (polling)
1847 * VirtualEthernet0/0/12 queue 1 (polling)
1848 * VirtualEthernet0/0/12 queue 2 (polling)
1849 * VirtualEthernet0/0/13 queue 0 (polling)
1850 * VirtualEthernet0/0/13 queue 2 (polling)
1851 * Thread 2 (vpp_wk_1):
1853 * GigabitEthernet7/0/1 queue 0 (polling)
1854 * node vhost-user-input:
1855 * VirtualEthernet0/0/12 queue 3 (polling)
1856 * VirtualEthernet0/0/13 queue 1 (polling)
1857 * VirtualEthernet0/0/13 queue 3 (polling)
1861 VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
1862 .path = "set interface rx-placement",
1863 .short_help = "set interface rx-placement <interface> [queue <n>] "
1864 "[worker <n> | main]",
1865 .function = set_interface_rx_placement,
1871 set_interface_rss_queues (vlib_main_t * vm, u32 hw_if_index,
1872 clib_bitmap_t * bitmap)
1874 vnet_main_t *vnm = vnet_get_main ();
1875 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1877 return vnet_hw_interface_set_rss_queues (vnm, hi, bitmap);
1880 static clib_error_t *
1881 set_interface_rss_queues_fn (vlib_main_t * vm,
1882 unformat_input_t * input,
1883 vlib_cli_command_t * cmd)
1885 clib_error_t *error = 0;
1886 unformat_input_t _line_input, *line_input = &_line_input;
1887 vnet_main_t *vnm = vnet_get_main ();
1888 u32 hw_if_index = (u32) ~ 0;
1889 clib_bitmap_t *bitmap = NULL;
1891 if (!unformat_user (input, unformat_line_input, line_input))
1894 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1897 (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1900 if (unformat (line_input, "list %U", unformat_bitmap_list, &bitmap))
1904 error = clib_error_return (0, "parse error: '%U'",
1905 format_unformat_error, line_input);
1906 unformat_free (line_input);
1911 unformat_free (line_input);
1913 if (hw_if_index == (u32) ~ 0)
1915 error = clib_error_return (0, "please specify valid interface name");
1921 error = clib_error_return (0, "please specify the valid rss queues");
1925 error = set_interface_rss_queues (vm, hw_if_index, bitmap);
1929 clib_bitmap_free (bitmap);
1935 * This command is used to set the rss queues of a given interface
1936 * Not all the interfaces support this operation.
1937 * To display the current rss queues, use the command
1938 * '<em>show hardware-interfaces</em>'.
1941 * Example of how to set the rss queues to 0,2-5,7 of an interface:
1942 * @cliexstart{set interface rss queues VirtualFunctionEthernet18/1/0 list 0,2-5,7}
1946 VLIB_CLI_COMMAND (cmd_set_interface_rss_queues,static) = {
1947 .path = "set interface rss queues",
1948 .short_help = "set interface rss queues <interface> <list <queue-list>>",
1949 .function = set_interface_rss_queues_fn,
1954 format_vnet_pcap (u8 * s, va_list * args)
1956 vnet_pcap_t *pp = va_arg (*args, vnet_pcap_t *);
1957 int type = va_arg (*args, int);
1962 if (pp->pcap_rx_enable)
1964 s = format (s, "rx");
1967 if (pp->pcap_tx_enable)
1970 s = format (s, " and ");
1971 s = format (s, "tx");
1974 if (pp->pcap_drop_enable)
1977 s = format (s, " and ");
1978 s = format (s, "drop");
1983 s = format (s, "unknown type %d!", type);
1989 vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
1991 vlib_main_t *vm = vlib_get_main ();
1992 vnet_pcap_t *pp = &vm->pcap;
1993 pcap_main_t *pm = &pp->pcap_main;
1994 vnet_classify_main_t *cm = &vnet_classify_main;
1995 vnet_classify_filter_set_t *set = 0;
1999 if (pp->pcap_rx_enable || pp->pcap_tx_enable || pp->pcap_drop_enable)
2002 (vm, "pcap %U dispatch capture enabled: %d of %d pkts...",
2003 format_vnet_pcap, pp, 0 /* print type */ ,
2004 pm->n_packets_captured, pm->n_packets_to_capture);
2005 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2008 vlib_cli_output (vm, "pcap dispatch capture disabled");
2013 /* Consistency checks */
2015 /* Enable w/ capture already enabled not allowed */
2016 if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
2017 && (a->rx_enable + a->tx_enable + a->drop_enable))
2018 return VNET_API_ERROR_INVALID_VALUE;
2020 /* Disable capture with capture already disabled, not interesting */
2021 if (((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable) == 0)
2022 && ((a->rx_enable + a->tx_enable + a->drop_enable == 0)))
2023 return VNET_API_ERROR_VALUE_EXIST;
2025 /* Change number of packets to capture while capturing */
2026 if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
2027 && (a->rx_enable + a->tx_enable + a->drop_enable)
2028 && (pm->n_packets_to_capture != a->packets_to_capture))
2029 return VNET_API_ERROR_INVALID_VALUE_2;
2031 set = pool_elt_at_index (cm->filter_sets, cm->filter_set_by_sw_if_index[0]);
2033 /* Classify filter specified, but no classify filter configured */
2034 if ((a->rx_enable + a->tx_enable + a->drop_enable) && a->filter &&
2035 (set->table_indices == 0 || set->table_indices[0] == ~0))
2036 return VNET_API_ERROR_NO_SUCH_LABEL;
2038 if (a->rx_enable + a->tx_enable + a->drop_enable)
2040 void *save_pcap_data;
2042 /* Sanity check max bytes per pkt */
2043 if (a->max_bytes_per_pkt < 32 || a->max_bytes_per_pkt > 9000)
2044 return VNET_API_ERROR_INVALID_MEMORY_SIZE;
2046 /* Clean up from previous run, if any */
2047 vec_reset_length (pm->pcap_data);
2049 /* Throw away the data buffer? */
2051 vec_free (pm->pcap_data);
2053 save_pcap_data = pm->pcap_data;
2055 memset (pm, 0, sizeof (*pm));
2057 pm->pcap_data = save_pcap_data;
2059 vec_validate_aligned (vnet_trace_placeholder, 2048,
2060 CLIB_CACHE_LINE_BYTES);
2062 clib_spinlock_init (&(pm->lock));
2064 if (a->filename == 0)
2069 stem = format (stem, "rx");
2071 stem = format (stem, "tx");
2073 stem = format (stem, "drop");
2074 a->filename = format (0, "/tmp/%v.pcap%c", stem, 0);
2078 pm->file_name = (char *) a->filename;
2079 pm->n_packets_captured = 0;
2080 pm->packet_type = PCAP_PACKET_TYPE_ethernet;
2081 /* Preallocate the data vector? */
2082 if (a->preallocate_data)
2085 (pm->pcap_data, a->packets_to_capture
2086 * ((sizeof (pcap_packet_header_t) + a->max_bytes_per_pkt)));
2087 vec_reset_length (pm->pcap_data);
2089 pm->n_packets_to_capture = a->packets_to_capture;
2090 pp->pcap_sw_if_index = a->sw_if_index;
2092 pp->filter_classify_table_index = set->table_indices[0];
2094 pp->filter_classify_table_index = ~0;
2095 pp->pcap_rx_enable = a->rx_enable;
2096 pp->pcap_tx_enable = a->tx_enable;
2097 pp->pcap_drop_enable = a->drop_enable;
2098 pp->max_bytes_per_pkt = a->max_bytes_per_pkt;
2102 pp->pcap_rx_enable = 0;
2103 pp->pcap_tx_enable = 0;
2104 pp->pcap_drop_enable = 0;
2105 pp->filter_classify_table_index = ~0;
2106 if (pm->n_packets_captured)
2108 clib_error_t *error;
2109 pm->n_packets_to_capture = pm->n_packets_captured;
2110 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2111 pm->n_packets_captured, pm->file_name);
2112 error = pcap_write (pm);
2113 if (pm->flags & PCAP_MAIN_INIT_DONE)
2115 /* Report I/O errors... */
2118 clib_error_report (error);
2119 return VNET_API_ERROR_SYSCALL_ERROR_1;
2121 vec_free (pm->file_name);
2123 vec_free (pm->pcap_data);
2127 return VNET_API_ERROR_NO_SUCH_ENTRY;
2133 static clib_error_t *
2134 pcap_trace_command_fn (vlib_main_t * vm,
2135 unformat_input_t * input, vlib_cli_command_t * cmd)
2137 unformat_input_t _line_input, *line_input = &_line_input;
2138 vnet_pcap_dispatch_trace_args_t _a, *a = &_a;
2139 vnet_main_t *vnm = vnet_get_main ();
2142 u32 max_bytes_per_pkt = 512;
2146 int preallocate_data = 0;
2147 int drop_enable = 0;
2151 u32 sw_if_index = 0; /* default: any interface */
2153 /* Get a line of input. */
2154 if (!unformat_user (input, unformat_line_input, line_input))
2157 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2159 if (unformat (line_input, "rx"))
2161 else if (unformat (line_input, "tx"))
2163 else if (unformat (line_input, "drop"))
2165 else if (unformat (line_input, "off"))
2166 rx_enable = tx_enable = drop_enable = 0;
2167 else if (unformat (line_input, "max-bytes-per-pkt %u",
2168 &max_bytes_per_pkt))
2170 else if (unformat (line_input, "max %d", &max))
2172 else if (unformat (line_input, "packets-to-capture %d", &max))
2174 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2177 else if (unformat (line_input, "status %=", &status, 1))
2179 else if (unformat (line_input, "intfc %U",
2180 unformat_vnet_sw_interface, vnm, &sw_if_index))
2182 else if (unformat (line_input, "interface %U",
2183 unformat_vnet_sw_interface, vnm, &sw_if_index))
2185 else if (unformat (line_input, "preallocate-data %=",
2186 &preallocate_data, 1))
2188 else if (unformat (line_input, "free-data %=", &free_data, 1))
2190 else if (unformat (line_input, "intfc any")
2191 || unformat (line_input, "interface any"))
2193 else if (unformat (line_input, "filter"))
2197 return clib_error_return (0, "unknown input `%U'",
2198 format_unformat_error, line_input);
2202 unformat_free (line_input);
2204 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2205 a->filename = filename;
2206 a->rx_enable = rx_enable;
2207 a->tx_enable = tx_enable;
2208 a->preallocate_data = preallocate_data;
2209 a->free_data = free_data;
2210 a->drop_enable = drop_enable;
2212 a->packets_to_capture = max;
2213 a->sw_if_index = sw_if_index;
2215 a->max_bytes_per_pkt = max_bytes_per_pkt;
2217 rv = vnet_pcap_dispatch_trace_configure (a);
2224 case VNET_API_ERROR_INVALID_VALUE:
2225 return clib_error_return (0, "dispatch trace already enabled...");
2227 case VNET_API_ERROR_VALUE_EXIST:
2228 return clib_error_return (0, "dispatch trace already disabled...");
2230 case VNET_API_ERROR_INVALID_VALUE_2:
2231 return clib_error_return
2232 (0, "can't change number of records to capture while tracing...");
2234 case VNET_API_ERROR_SYSCALL_ERROR_1:
2235 return clib_error_return (0, "I/O writing trace capture...");
2237 case VNET_API_ERROR_NO_SUCH_ENTRY:
2238 return clib_error_return (0, "No packets captured...");
2240 case VNET_API_ERROR_INVALID_MEMORY_SIZE:
2241 return clib_error_return (0,
2242 "Max bytes per pkt must be > 32, < 9000...");
2244 case VNET_API_ERROR_NO_SUCH_LABEL:
2245 return clib_error_return
2246 (0, "No classify filter configured, see 'classify filter...'");
2249 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2256 * This command is used to start or stop a packet capture, or show
2257 * the status of packet capture.
2259 * This command has the following optional parameters:
2262 * - <b>rx</b> - Capture received packets
2264 * - <b>tx</b> - Capture transmitted packets
2266 * - <b>drop</b> - Capture dropped packets
2268 * - <b>off</b> - Stop capturing packets, write results to the specified file
2270 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2271 * of packets have been received, buffer is flushed to file. Once another
2272 * '<em>nn</em>' number of packets have been received, buffer is flushed
2273 * to file, overwriting previous write. If not entered, value defaults
2274 * to 100. Can only be updated if packet capture is off.
2276 * - <b>max-bytes-per-pkt <nnnn></b> - Maximum number of bytes to capture
2277 * for each packet. Must be >= 32, <= 9000.
2279 * - <b>preallocate-data</b> - Preallocate the data buffer, to avoid
2280 * vector expansion delays during pcap capture
2282 * - <b>free-data</b> - Free the data buffer. Ordinarily it's a feature
2283 * to retain the data buffer so this option is seldom used.
2285 * - <b>intfc <interface-name>|any</b> - Used to specify a given interface,
2286 * or use '<em>any</em>' to run packet capture on all interfaces.
2287 * '<em>any</em>' is the default if not provided. Settings from a previous
2288 * packet capture are preserved, so '<em>any</em>' can be used to reset
2289 * the interface setting.
2291 * - <b>filter</b> - Use the pcap rx / tx / drop trace filter, which
2292 * must be configured. Use <b>classify filter pcap...</b> to configure the
2293 * filter. The filter will only be executed if the per-interface or
2294 * any-interface tests fail.
2296 * - <b>file <name></b> - Used to specify the output filename. The file will
2297 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2298 * supported. Directory should not be entered. If file already exists, file
2299 * will be overwritten. If no filename is provided, the file will be
2300 * named "/tmp/rx.pcap", "/tmp/tx.pcap", "/tmp/rxandtx.pcap", etc.
2301 * Can only be updated if packet capture is off.
2303 * - <b>status</b> - Displays the current status and configured attributes
2304 * associated with a packet capture. If packet capture is in progress,
2305 * '<em>status</em>' also will return the number of packets currently in
2306 * the local buffer. All additional attributes entered on command line
2307 * with '<em>status</em>' will be ignored and not applied.
2310 * Example of how to display the status of a tx packet capture when off:
2311 * @cliexstart{pcap trace status}
2312 * max is 100, for any interface to file /tmp/vpe.pcap
2313 * pcap tx capture is off...
2315 * Example of how to start a tx packet capture:
2316 * @cliexstart{pcap trace tx max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
2318 * Example of how to display the status of a tx packet capture in progress:
2319 * @cliexstart{pcap trace status}
2320 * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
2321 * pcap tx capture is on: 20 of 35 pkts...
2323 * Example of how to stop a tx packet capture:
2324 * @cliexstart{pcap trace off}
2325 * captured 21 pkts...
2326 * saved to /tmp/vppTest.pcap...
2331 VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
2332 .path = "pcap trace",
2334 "pcap trace [rx] [tx] [drop] [off] [max <nn>] [intfc <interface>|any]\n"
2335 " [file <name>] [status] [max-bytes-per-pkt <nnnn>][filter]\n"
2336 " [preallocate-data][free-data]",
2337 .function = pcap_trace_command_fn,
2342 * fd.io coding-style-patch-verification: ON
2345 * eval: (c-set-style "gnu")