/**
* @file
- * Interface CLI.
+ * @brief Interface CLI.
+ *
+ * Source code for several CLI interface commands.
+ *
*/
#include <vnet/vnet.h>
#include <vppinfra/bitmap.h>
#include <vnet/fib/ip4_fib.h>
#include <vnet/fib/ip6_fib.h>
+#include <vnet/l2/l2_output.h>
+#include <vnet/l2/l2_input.h>
static int
compare_interface_names (void *a1, void *a2)
return error;
}
-/* *INDENT-OFF* */
/*?
- * Displays various information about the state of the current terminal
- * session.
+ * Display more detailed information about all or a list of given interfaces.
+ * The verboseness of the output can be controlled by the following optional
+ * parameters:
+ * - brief: Only show name, index and state (default for bonded interfaces).
+ * - verbose: Also display additional attributes (default for all other interfaces).
+ * - detail: Also display all remaining attributes and extended statistics.
+ *
+ * To limit the output of the command to bonded interfaces and their slave
+ * interfaces, use the '<em>bond</em>' optional parameter.
*
* @cliexpar
- * @cliexstart{show hardware}
- * Name Link Hardware
- * GigabitEthernet2/0/0 up GigabitEthernet2/0/0
- * Ethernet address 00:50:56:b7:7c:83
- * Intel 82545em_copper
- * link up, media 1000T full-duplex, master,
- * 0 unprocessed, 384 total buffers on rx queue 0 ring
- * 237 buffers in driver rx cache
- * rx total packets 1816
- * rx total bytes 181084
- * rx good packets 1816
- * rx good bytes 181084
- * rx 65 127 byte packets 1586
- * rx 256 511 byte packets 230
- * tx total packets 346
- * tx total bytes 90224
- * tx good packets 346
- * tx good bytes 88840
- * tx 64 byte packets 1
- * tx 65 127 byte packets 115
- * tx 256 511 byte packets 230
+ * Example of how to display default data for all interfaces:
+ * @cliexstart{show hardware-interfaces}
+ * Name Idx Link Hardware
+ * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
+ * Ethernet address ec:f4:bb:c0:bc:fc
+ * Intel e1000
+ * carrier up full duplex speed 1000 mtu 9216
+ * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+ * cpu socket 0
+ * GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
+ * Ethernet address ec:f4:bb:c0:bc:fd
+ * Intel e1000
+ * carrier up full duplex speed 1000 mtu 9216
+ * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+ * cpu socket 0
+ * VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
+ * Ethernet address 02:fe:a5:a9:8b:8e
+ * VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
+ * Ethernet address 02:fe:c0:4e:3b:b0
+ * VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
+ * Ethernet address 02:fe:1f:73:92:81
+ * VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
+ * Ethernet address 02:fe:f2:25:c4:68
+ * local0 0 down local0
+ * local
+ * @cliexend
+ * Example of how to display '<em>verbose</em>' data for an interface by name and
+ * software index (where 2 is the software index):
+ * @cliexstart{show hardware-interfaces GigabitEthernet7/0/0 2 verbose}
+ * Name Idx Link Hardware
+ * GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
+ * Ethernet address ec:f4:bb:c0:bc:fc
+ * Intel e1000
+ * carrier up full duplex speed 1000 mtu 9216
+ * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+ * cpu socket 0
+ * GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
+ * Ethernet address ec:f4:bb:c0:bc:fd
+ * Intel e1000
+ * carrier up full duplex speed 1000 mtu 9216
+ * rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+ * cpu socket 0
* @cliexend
?*/
+/* *INDENT-OFF* */
VLIB_CLI_COMMAND (show_hw_interfaces_command, static) = {
.path = "show hardware-interfaces",
- .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] [<if-name1> <if-name2> ...]",
+ .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] "
+ "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
.function = show_or_clear_hw_interfaces,
};
/* *INDENT-ON* */
+
+/*?
+ * Clear the extended statistics for all or a list of given interfaces
+ * (statistics associated with the '<em>show hardware-interfaces</em>' command).
+ *
+ * @cliexpar
+ * Example of how to clear the extended statistics for all interfaces:
+ * @cliexcmd{clear hardware-interfaces}
+ * Example of how to clear the extended statistics for an interface by
+ * name and software index (where 2 is the software index):
+ * @cliexcmd{clear hardware-interfaces GigabitEthernet7/0/0 2}
+ ?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (clear_hw_interface_counters_command, static) = {
.path = "clear hardware-interfaces",
- .short_help = "Clear hardware interfaces statistics",
+ .short_help = "clear hardware-interfaces "
+ "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
.function = show_or_clear_hw_interfaces,
};
/* *INDENT-ON* */
{
clib_error_t *error = 0;
vnet_main_t *vnm = vnet_get_main ();
+ unformat_input_t _linput, *linput = &_linput;
vnet_interface_main_t *im = &vnm->interface_main;
vnet_sw_interface_t *si, *sorted_sis = 0;
u32 sw_if_index = ~(u32) 0;
u8 show_addresses = 0;
u8 show_features = 0;
u8 show_tag = 0;
+ int verbose = 0;
- while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+ /*
+ * Get a line of input. Won't work if the user typed
+ * "show interface" and nothing more.
+ */
+ if (unformat_user (input, unformat_line_input, linput))
{
- /* See if user wants to show specific interface */
- if (unformat
- (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
+ while (unformat_check_input (linput) != UNFORMAT_END_OF_INPUT)
{
- si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
- vec_add1 (sorted_sis, si[0]);
- }
- else if (unformat (input, "address") || unformat (input, "addr"))
- show_addresses = 1;
- else if (unformat (input, "features") || unformat (input, "feat"))
- show_features = 1;
- else if (unformat (input, "tag"))
- show_tag = 1;
- else
- {
- error = clib_error_return (0, "unknown input `%U'",
- format_unformat_error, input);
- goto done;
+ /* See if user wants to show specific interface */
+ if (unformat
+ (linput, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
+ {
+ si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
+ vec_add1 (sorted_sis, si[0]);
+ }
+ else if (unformat (linput, "address") || unformat (linput, "addr"))
+ show_addresses = 1;
+ else if (unformat (linput, "features") || unformat (linput, "feat"))
+ show_features = 1;
+ else if (unformat (linput, "tag"))
+ show_tag = 1;
+ else if (unformat (linput, "verbose"))
+ verbose = 1;
+ else
+ {
+ vec_free (sorted_sis);
+ error = clib_error_return (0, "unknown input `%U'",
+ format_unformat_error, linput);
+ goto done;
+ }
}
+ unformat_free (linput);
}
-
if (show_features || show_tag)
{
if (sw_if_index == ~(u32) 0)
- return clib_error_return (0, "Interface not specified...");
+ {
+ vec_free (sorted_sis);
+ return clib_error_return (0, "Interface not specified...");
+ }
}
if (show_features)
{
- vnet_interface_features_show (vm, sw_if_index);
+ vnet_interface_features_show (vm, sw_if_index, verbose);
+
+ l2_input_config_t *l2_input = l2input_intf_config (sw_if_index);
+ u32 fb = l2_input->feature_bitmap;
+ /* intf input features are masked by bridge domain */
+ if (l2_input->bridge)
+ fb &= l2input_bd_config (l2_input->bd_index)->feature_bitmap;
+ vlib_cli_output (vm, "\nl2-input:\n%U", format_l2_input_features, fb,
+ 1);
+
+ l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
+ vlib_cli_output (vm, "\nl2-output:");
+ if (l2_output->out_vtr_flag)
+ vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
+ vlib_cli_output (vm, "%U", format_l2_output_features,
+ l2_output->feature_bitmap, 1);
+ vec_free (sorted_sis);
return 0;
}
if (show_tag)
vlib_cli_output (vm, "%U: %s",
format_vnet_sw_if_index_name, vnm, sw_if_index,
tag ? (char *) tag : "(none)");
+ vec_free (sorted_sis);
return 0;
}
sorted_sis =
vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
_vec_len (sorted_sis) = 0;
- pool_foreach (si, im->sw_interfaces, (
- {
- if (vnet_swif_is_api_visible
- (si)) vec_add1 (sorted_sis,
- si[0]);}
- ));
-
+ /* *INDENT-OFF* */
+ pool_foreach (si, im->sw_interfaces,
+ ({
+ int visible = vnet_swif_is_api_visible (si);
+ if (visible)
+ vec_add1 (sorted_sis, si[0]);}
+ ));
+ /* *INDENT-ON* */
/* Sort by name. */
vec_sort_with_function (sorted_sis, sw_interface_name_compare);
}
{
vec_foreach (si, sorted_sis)
{
- l2input_main_t *l2m = &l2input_main;
ip4_main_t *im4 = &ip4_main;
ip6_main_t *im6 = &ip6_main;
ip_lookup_main_t *lm4 = &im4->lookup_main;
ip_lookup_main_t *lm6 = &im6->lookup_main;
ip_interface_address_t *ia = 0;
- ip4_address_t *r4;
- ip6_address_t *r6;
u32 fib_index4 = 0, fib_index6 = 0;
- ip4_fib_t *fib4;
- ip6_fib_t *fib6;
- l2_input_config_t *config;
if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
si->sw_if_index);
- fib4 = ip4_fib_get (fib_index4);
- fib6 = ip6_fib_get (fib_index6);
+ ip4_fib_t *fib4 = ip4_fib_get (fib_index4);
+ ip6_fib_t *fib6 = ip6_fib_get (fib_index6);
if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
vlib_cli_output
(vm, "%U (%s): \n unnumbered, use %U",
- format_vnet_sw_if_index_name,
- vnm, si->sw_if_index,
+ format_vnet_sw_if_index_name, vnm, si->sw_if_index,
(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
-
else
- {
- vlib_cli_output (vm, "%U (%s):",
- format_vnet_sw_if_index_name,
- vnm, si->sw_if_index,
- (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
- ? "up" : "dn");
- }
+ vlib_cli_output
+ (vm, "%U (%s):",
+ format_vnet_sw_if_index_name, vnm, si->sw_if_index,
+ (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn");
- /* Display any L2 addressing info */
- vec_validate (l2m->configs, si->sw_if_index);
- config = vec_elt_at_index (l2m->configs, si->sw_if_index);
- if (config->bridge)
+ /* Display any L2 info */
+ l2_input_config_t *l2_input = l2input_intf_config (si->sw_if_index);
+ if (l2_input->bridge)
{
- u32 bd_id = l2input_main.bd_configs[config->bd_index].bd_id;
- vlib_cli_output (vm, " l2 bridge bd_id %d%s%d", bd_id,
- config->bvi ? " bvi shg " : " shg ",
- config->shg);
- }
- else if (config->xconnect)
- {
- vlib_cli_output (vm, " l2 xconnect %U",
- format_vnet_sw_if_index_name,
- vnm, config->output_sw_if_index);
+ bd_main_t *bdm = &bd_main;
+ u32 bd_id = l2input_main.bd_configs[l2_input->bd_index].bd_id;
+ vlib_cli_output (vm, " L2 bridge bd-id %d idx %d shg %d %s",
+ bd_id, bd_find_index (bdm, bd_id), l2_input->shg,
+ l2_input->bvi ? "bvi" : " ");
}
+ else if (l2_input->xconnect)
+ vlib_cli_output (vm, " L2 xconnect %U",
+ format_vnet_sw_if_index_name, vnm,
+ l2_input->output_sw_if_index);
+ /* *INDENT-OFF* */
/* Display any IP4 addressing info */
- /* *INDENT-OFF* */
- foreach_ip_interface_address (lm4, ia, si->sw_if_index,
- 1 /* honor unnumbered */,
- ({
- r4 = ip_interface_address_get_address (lm4, ia);
- if (fib4->table_id)
- {
- vlib_cli_output (vm, " %U/%d table %d",
- format_ip4_address, r4,
- ia->address_length,
- fib4->table_id);
- }
- else
- {
- vlib_cli_output (vm, " %U/%d",
- format_ip4_address, r4,
- ia->address_length);
- }
- }));
- /* *INDENT-ON* */
-
+ foreach_ip_interface_address (lm4, ia, si->sw_if_index,
+ 1 /* honor unnumbered */,
+ ({
+ ip4_address_t *r4 = ip_interface_address_get_address (lm4, ia);
+ if (fib4->table_id)
+ vlib_cli_output (vm, " L3 %U/%d ip4 table-id %d fib-idx %d",
+ format_ip4_address, r4, ia->address_length,
+ fib4->table_id,
+ ip4_fib_index_from_table_id (fib4->table_id));
+ else
+ vlib_cli_output (vm, " L3 %U/%d",
+ format_ip4_address, r4, ia->address_length);
+ }));
+ /* *INDENT-ON* */
+
+ /* *INDENT-OFF* */
/* Display any IP6 addressing info */
- /* *INDENT-OFF* */
- foreach_ip_interface_address (lm6, ia, si->sw_if_index,
- 1 /* honor unnumbered */,
- ({
- r6 = ip_interface_address_get_address (lm6, ia);
- if (fib6->table_id)
- {
- vlib_cli_output (vm, " %U/%d table %d",
- format_ip6_address, r6,
- ia->address_length,
- fib6->table_id);
- }
- else
- {
- vlib_cli_output (vm, " %U/%d",
- format_ip6_address, r6,
- ia->address_length);
- }
- }));
- /* *INDENT-ON* */
+ foreach_ip_interface_address (lm6, ia, si->sw_if_index,
+ 1 /* honor unnumbered */,
+ ({
+ ip6_address_t *r6 = ip_interface_address_get_address (lm6, ia);
+ if (fib6->table_id)
+ vlib_cli_output (vm, " L3 %U/%d ip6 table-id %d fib-idx %d",
+ format_ip6_address, r6, ia->address_length,
+ fib6->table_id,
+ ip6_fib_index_from_table_id (fib6->table_id));
+ else
+ vlib_cli_output (vm, " L3 %U/%d",
+ format_ip6_address, r6, ia->address_length);
+ }));
+ /* *INDENT-ON* */
}
}
else
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
.path = "show interface",
- .short_help = "show interface [address|addr|features|feat] [<if-name1> <if-name2> ...]",
+ .short_help = "show interface [address|addr|features|feat] [<interface> [<interface> [..]]] [verbose]",
.function = show_sw_interfaces,
+ .is_mp_safe = 1,
};
/* *INDENT-ON* */
vnet_interface_main_t *im = &vnm->interface_main;
vlib_simple_counter_main_t *sm;
vlib_combined_counter_main_t *cm;
- static vnet_main_t **my_vnet_mains;
- int i, j, n_counters;
-
- vec_reset_length (my_vnet_mains);
-
- for (i = 0; i < vec_len (vnet_mains); i++)
- {
- if (vnet_mains[i])
- vec_add1 (my_vnet_mains, vnet_mains[i]);
- }
-
- if (vec_len (vnet_mains) == 0)
- vec_add1 (my_vnet_mains, vnm);
+ int j, n_counters;
n_counters = vec_len (im->combined_sw_if_counters);
for (j = 0; j < n_counters; j++)
{
- for (i = 0; i < vec_len (my_vnet_mains); i++)
- {
- im = &my_vnet_mains[i]->interface_main;
- cm = im->combined_sw_if_counters + j;
- vlib_clear_combined_counters (cm);
- }
+ im = &vnm->interface_main;
+ cm = im->combined_sw_if_counters + j;
+ vlib_clear_combined_counters (cm);
}
n_counters = vec_len (im->sw_if_counters);
for (j = 0; j < n_counters; j++)
{
- for (i = 0; i < vec_len (my_vnet_mains); i++)
- {
- im = &my_vnet_mains[i]->interface_main;
- sm = im->sw_if_counters + j;
- vlib_clear_simple_counters (sm);
- }
+ im = &vnm->interface_main;
+ sm = im->sw_if_counters + j;
+ vlib_clear_simple_counters (sm);
}
return 0;
}
+/*?
+ * Clear the statistics for all interfaces (statistics associated with the
+ * '<em>show interface</em>' command).
+ *
+ * @cliexpar
+ * Example of how to clear the statistics for all interfaces:
+ * @cliexcmd{clear interfaces}
+ ?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
.path = "clear interfaces",
- .short_help = "Clear interfaces statistics",
+ .short_help = "clear interfaces",
.function = clear_interface_counters,
};
/* *INDENT-ON* */
goto done;
}
- memset (&template, 0, sizeof (template));
+ clib_memset (&template, 0, sizeof (template));
template.sub.eth.raw_flags = 0;
if (unformat (input, "%d default", &id_min))
return error;
}
-/* *INDENT-OFF* */
/*?
- * Create vlan subinterfaces
+ * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
+ * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
+ * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
+ * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
+ * but this is not recommended.
+ *
+ * This command has several variations:
+ * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
+ * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
+ *
+ * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
+ * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
+ * match any other subinterfaces should be sent to this subinterface.
+ *
+ * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
+ * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
+ * to this subinterface.
+ *
+ * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
+ * subinterfaces to handle a range of VLAN IDs.
+ *
+ * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
+ * Use this command to specify the outer VLAN ID, to either be explicit or to make the
+ * VLAN ID different from the '<em>subId</em>'.
+ *
+ * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
+ * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
+ * the inner VLAN ID.
+ *
+ * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explicitly entered, subinterfaces
+ * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
+ * default. If '<em>exact-match</em>' is specified, packets must have the same number of
+ * VLAN tags as the configuration. For non-exact-match, packets must at least that number
+ * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
+ * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
+ * entered, then the default behavior is exact-match.
+ *
+ * Use the '<em>show interface</em>' command to display all subinterfaces.
*
* @cliexpar
- * @cliexstart{create sub-interfaces}
+ * @parblock
+ * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
*
- * To create a vlan subinterface 11 to process packets on 802.1q VLAN id 11, use:
+ * The previous example is shorthand and is equivalent to:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
*
- * vpp# create sub GigabitEthernet2/0/0 11
*
- * This shorthand is equivalent to:
- * vpp# create sub GigabitEthernet2/0/0 11 dot1q 11 exact-match
+ * Example of how to create a subinterface number that is different from the VLAN ID:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
*
- * You can specify a subinterface number that is different from the vlan id:
- * vpp# create sub GigabitEthernet2/0/0 11 dot1q 100
*
- * You can create qinq and q-in-any interfaces:
- * vpp# create sub GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200
- * vpp# create sub GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any
+ * Examples of how to create q-in-q and q-in-any subinterfaces:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
*
- * You can also create dot1ad interfaces:
- * vpp# create sub GigabitEthernet2/0/0 11 dot1ad 11
- * vpp# create sub GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q 200
+ * Examples of how to create dot1ad interfaces:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
*
- * Subinterfaces can be configured as either exact-match or non-exact match.
- * Non-exact match is the CLI default. If exact-match is specified,
- * packets must have the same number of vlan tags as the configuration.
- * For non-exact-match, packets must at least that number of tags.
- * L3 (routed) interfaces must be configured as exact-match.
- * L2 interfaces are typically configured as non-exact-match.
*
- * For example, a packet with outer vlan 100 and inner 200 would match this interface:
- * vpp# create sub GigabitEthernet2/0/0 5 dot1q 100
+ * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
+ * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
+ * is non-exact match:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
*
- * but would not match this interface:
- * vpp# create sub GigabitEthernet2/0/0 5 dot1q 100 exact-match
+ * However, the same packet would NOT match this interface because '<em>exact-match</em>'
+ * is specified and only one VLAN is configured, but packet contains two VLANs:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
*
- * There are two special subinterfaces that can be configured. Subinterface untagged has no vlan tags:
- * vpp# create sub GigabitEthernet2/0/0 5 untagged
*
- * The subinterface default matches any packet that does not match any other subinterface:
- * vpp# create sub GigabitEthernet2/0/0 7 default
- * @cliexend
+ * Example of how to created a subinterface to process untagged packets:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
+ *
+ * Example of how to created a subinterface to process any packet with a VLAN ID that
+ * does not match any other subinterface:
+ * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
+ *
+ * When subinterfaces are created, they are in the down state. Example of how to
+ * enable a newly created subinterface:
+ * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
+ * @endparblock
?*/
+/* *INDENT-OFF* */
VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
.path = "create sub-interfaces",
- .short_help = "create sub-interfaces <nn>[-<nn>] [dot1q|dot1ad|default|untagged]",
+ .short_help = "create sub-interfaces <interface> "
+ "{<subId> [default|untagged]} | "
+ "{<subId>-<subId>} | "
+ "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
.function = create_sub_interfaces,
};
/* *INDENT-ON* */
}
-/* *INDENT-OFF* */
/*?
- * Interface admin up/down
+ * This command is used to change the admin state (up/down) of an interface.
+ *
+ * If an interface is down, the optional '<em>punt</em>' flag can also be set.
+ * The '<em>punt</em>' flag implies the interface is disabled for forwarding
+ * but punt all traffic to slow-path. Use the '<em>enable</em>' flag to clear
+ * '<em>punt</em>' flag (interface is still down).
*
* @cliexpar
- * @cliexstart{set interface state}
- * vpp# set interface state GigabitEthernet2/0/0 up
- * vpp# set interface state GigabitEthernet2/0/0 down
- * @cliexend
+ * Example of how to configure the admin state of an interface to '<em>up</em?':
+ * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
+ * Example of how to configure the admin state of an interface to '<em>down</em?':
+ * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
?*/
+/* *INDENT-OFF* */
VLIB_CLI_COMMAND (set_state_command, static) = {
.path = "set interface state",
- .short_help = "set interface state <if-name> [up|down|punt|enable]",
+ .short_help = "set interface state <interface> [up|down|punt|enable]",
.function = set_state,
};
/* *INDENT-ON* */
unformat_input_t * input, vlib_cli_command_t * cmd)
{
vnet_main_t *vnm = vnet_get_main ();
- u32 unnumbered_sw_if_index;
- u32 inherit_from_sw_if_index;
- vnet_sw_interface_t *si;
- int is_set = 0;
- int is_del = 0;
- u32 was_unnum;
+ u32 unnumbered_sw_if_index = ~0;
+ u32 inherit_from_sw_if_index = ~0;
+ int enable = 1;
if (unformat (input, "%U use %U",
unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
- is_set = 1;
+ enable = 1;
else if (unformat (input, "del %U",
unformat_vnet_sw_interface, vnm,
&unnumbered_sw_if_index))
- is_del = 1;
+ enable = 0;
else
return clib_error_return (0, "parse error '%U'",
format_unformat_error, input);
- si = vnet_get_sw_interface (vnm, unnumbered_sw_if_index);
- was_unnum = (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED);
+ if (~0 == unnumbered_sw_if_index)
+ return clib_error_return (0, "Specify the unnumbered interface");
+ if (enable && ~0 == inherit_from_sw_if_index)
+ return clib_error_return (0, "When enabling unnumbered specify the"
+ " IP enabled interface that it uses");
- if (is_del)
- {
- si->flags &= ~(VNET_SW_INTERFACE_FLAG_UNNUMBERED);
- si->unnumbered_sw_if_index = (u32) ~ 0;
+ vnet_sw_interface_update_unnumbered (unnumbered_sw_if_index,
+ inherit_from_sw_if_index, enable);
- ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
- [unnumbered_sw_if_index] = ~0;
- ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
- [unnumbered_sw_if_index] = ~0;
- }
- else if (is_set)
- {
- si->flags |= VNET_SW_INTERFACE_FLAG_UNNUMBERED;
- si->unnumbered_sw_if_index = inherit_from_sw_if_index;
-
- ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
- [unnumbered_sw_if_index] =
- ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
- [inherit_from_sw_if_index];
- ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
- [unnumbered_sw_if_index] =
- ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
- [inherit_from_sw_if_index];
- }
-
- if (was_unnum != (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED))
- {
- ip4_sw_interface_enable_disable (unnumbered_sw_if_index, !is_del);
- ip6_sw_interface_enable_disable (unnumbered_sw_if_index, !is_del);
- }
-
- return 0;
+ return (NULL);
}
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
.path = "set interface unnumbered",
- .short_help = "set interface unnumbered [<intfc> use <intfc> | del <intfc>]",
+ .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
.function = set_unnumbered,
};
/* *INDENT-ON* */
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (renumber_interface_command, static) = {
.path = "renumber interface",
- .short_help = "renumber interface <if-name> <new-dev-instance>",
+ .short_help = "renumber interface <interface> <new-dev-instance>",
.function = renumber_interface_command_fn,
};
/* *INDENT-ON* */
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
.path = "set interface promiscuous",
- .short_help = "set interface promiscuous [on | off] <intfc>",
+ .short_help = "set interface promiscuous [on|off] <interface>",
.function = promiscuous_cmd,
};
/* *INDENT-ON* */
mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
{
vnet_main_t *vnm = vnet_get_main ();
- u32 hw_if_index, mtu;
- u32 flags = ETHERNET_INTERFACE_FLAG_MTU;
+ u32 hw_if_index, sw_if_index, mtu;
ethernet_main_t *em = ðernet_main;
+ u32 mtus[VNET_N_MTU] = { 0, 0, 0, 0 };
if (unformat (input, "%d %U", &mtu,
unformat_vnet_hw_interface, vnm, &hw_if_index))
{
+ /*
+ * Change physical MTU on interface. Only supported for Ethernet
+ * interfaces
+ */
vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
hi->max_supported_packet_bytes);
- if (hi->max_packet_bytes != mtu)
- {
- hi->max_packet_bytes = mtu;
- ethernet_set_flags (vnm, hw_if_index, flags);
- }
+ vnet_hw_interface_set_mtu (vnm, hw_if_index, mtu);
+ goto done;
}
+ else if (unformat (input, "packet %d %U", &mtu,
+ unformat_vnet_sw_interface, vnm, &sw_if_index))
+ /* Set default packet MTU (including L3 header */
+ mtus[VNET_MTU_L3] = mtu;
+ else if (unformat (input, "ip4 %d %U", &mtu,
+ unformat_vnet_sw_interface, vnm, &sw_if_index))
+ mtus[VNET_MTU_IP4] = mtu;
+ else if (unformat (input, "ip6 %d %U", &mtu,
+ unformat_vnet_sw_interface, vnm, &sw_if_index))
+ mtus[VNET_MTU_IP6] = mtu;
+ else if (unformat (input, "mpls %d %U", &mtu,
+ unformat_vnet_sw_interface, vnm, &sw_if_index))
+ mtus[VNET_MTU_MPLS] = mtu;
else
return clib_error_return (0, "unknown input `%U'",
format_unformat_error, input);
+
+ vnet_sw_interface_set_protocol_mtu (vnm, sw_if_index, mtus);
+
+done:
return 0;
}
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
.path = "set interface mtu",
- .short_help = "set interface mtu <value> <intfc>",
+ .short_help = "set interface mtu [packet|ip4|ip6|mpls] <value> <interface>",
.function = mtu_cmd,
};
/* *INDENT-ON* */
+static clib_error_t *
+show_interface_sec_mac_addr_fn (vlib_main_t * vm, unformat_input_t * input,
+ vlib_cli_command_t * cmd)
+{
+ vnet_main_t *vnm = vnet_get_main ();
+ vnet_interface_main_t *im = &vnm->interface_main;
+ ethernet_main_t *em = ðernet_main;
+ u32 sw_if_index = ~0;
+ vnet_sw_interface_t *si, *sorted_sis = 0;
+
+ if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
+ {
+ si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
+ vec_add1 (sorted_sis, si[0]);
+ }
+
+ /* if an interface name was not passed, get all interfaces */
+ if (vec_len (sorted_sis) == 0)
+ {
+ sorted_sis =
+ vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
+ _vec_len (sorted_sis) = 0;
+ /* *INDENT-OFF* */
+ pool_foreach (si, im->sw_interfaces,
+ ({
+ int visible = vnet_swif_is_api_visible (si);
+ if (visible)
+ vec_add1 (sorted_sis, si[0]);}
+ ));
+ /* *INDENT-ON* */
+ /* Sort by name. */
+ vec_sort_with_function (sorted_sis, sw_interface_name_compare);
+ }
+
+ vec_foreach (si, sorted_sis)
+ {
+ vnet_sw_interface_t *sup_si;
+ ethernet_interface_t *ei;
+
+ sup_si = vnet_get_sup_sw_interface (vnm, si->sw_if_index);
+ ei = ethernet_get_interface (em, sup_si->hw_if_index);
+
+ vlib_cli_output (vm, "%U (%s):",
+ format_vnet_sw_if_index_name, vnm, si->sw_if_index,
+ (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
+ "up" : "dn");
+
+ if (ei && ei->secondary_addrs)
+ {
+ mac_address_t *sec_addr;
+
+ vec_foreach (sec_addr, ei->secondary_addrs)
+ {
+ vlib_cli_output (vm, " %U", format_mac_address_t, sec_addr);
+ }
+ }
+ }
+
+ vec_free (sorted_sis);
+ return 0;
+}
+
+/*?
+ * This command is used to display interface secondary mac addresses.
+ *
+ * @cliexpar
+ * Example of how to display interface secondary mac addresses:
+ * @cliexstart{show interface secondary-mac-address}
+ * @cliexend
+?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (show_interface_sec_mac_addr, static) = {
+ .path = "show interface secondary-mac-address",
+ .short_help = "show interface secondary-mac-address [<interface>]",
+ .function = show_interface_sec_mac_addr_fn,
+};
+/* *INDENT-ON* */
+
+static clib_error_t *
+interface_add_del_mac_address (vlib_main_t * vm, unformat_input_t * input,
+ vlib_cli_command_t * cmd)
+{
+ vnet_main_t *vnm = vnet_get_main ();
+ vnet_sw_interface_t *si = NULL;
+ clib_error_t *error = 0;
+ u32 sw_if_index = ~0;
+ u8 mac[6] = { 0 };
+ u8 is_add, is_del;
+
+ is_add = is_del = 0;
+
+ if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
+ {
+ error = clib_error_return (0, "unknown interface `%U'",
+ format_unformat_error, input);
+ goto done;
+ }
+ if (!unformat_user (input, unformat_ethernet_address, mac))
+ {
+ error = clib_error_return (0, "expected mac address `%U'",
+ format_unformat_error, input);
+ goto done;
+ }
+
+ while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+ {
+ if (unformat (input, "add"))
+ is_add = 1;
+ else if (unformat (input, "del"))
+ is_del = 1;
+ else
+ break;
+ }
+
+ if (is_add == is_del)
+ {
+ error = clib_error_return (0, "must choose one of add or del");
+ goto done;
+ }
+
+ si = vnet_get_sw_interface (vnm, sw_if_index);
+ error =
+ vnet_hw_interface_add_del_mac_address (vnm, si->hw_if_index, mac, is_add);
+
+done:
+ return error;
+}
+
+/*?
+ * The '<em>set interface secondary-mac-address </em>' command allows adding
+ * or deleting extra MAC addresses on a given interface without changing the
+ * default MAC address. This could allow packets sent to these MAC addresses
+ * to be received without setting the interface to promiscuous mode.
+ * Not all interfaces support this operation. The ones that do are mostly
+ * hardware NICs, though virtio does also.
+ *
+ * @cliexpar
+ * @parblock
+ * Example of how to add a secondary MAC Address on an interface:
+ * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 add}
+ * Example of how to delete a secondary MAC address from an interface:
+ * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 del}
+ * @endparblock
+?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (interface_add_del_mac_address_cmd, static) = {
+ .path = "set interface secondary-mac-address",
+ .short_help = "set interface secondary-mac-address <interface> <mac-address> [(add|del)]",
+ .function = interface_add_del_mac_address,
+};
+/* *INDENT-ON* */
+
static clib_error_t *
set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
vlib_cli_command_t * cmd)
{
vnet_main_t *vnm = vnet_get_main ();
+ vnet_sw_interface_t *si = NULL;
clib_error_t *error = 0;
u32 sw_if_index = ~0;
- u64 mac = 0;
+ u8 mac[6] = { 0 };
if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
{
format_unformat_error, input);
goto done;
}
- if (!unformat_user (input, unformat_ethernet_address, &mac))
+ if (!unformat_user (input, unformat_ethernet_address, mac))
{
error = clib_error_return (0, "expected mac address `%U'",
format_unformat_error, input);
goto done;
}
- error = vnet_hw_interface_change_mac_address (vnm, sw_if_index, mac);
+ si = vnet_get_sw_interface (vnm, sw_if_index);
+ error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
done:
return error;
}
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
.path = "set interface mac address",
- .short_help = "set interface mac address <intfc> <mac-address>",
+ .short_help = "set interface mac address <interface> <mac-address>",
.function = set_interface_mac_address,
};
/* *INDENT-ON* */
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (set_tag_command, static) = {
.path = "set interface tag",
- .short_help = "set interface tag <intfc> <tag>",
+ .short_help = "set interface tag <interface> <tag>",
.function = set_tag,
};
/* *INDENT-ON* */
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (clear_tag_command, static) = {
.path = "clear interface tag",
- .short_help = "clear interface tag <intfc>",
+ .short_help = "clear interface tag <interface>",
.function = clear_tag,
};
/* *INDENT-ON* */
+static clib_error_t *
+set_ip_directed_broadcast (vlib_main_t * vm,
+ unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+ vnet_main_t *vnm = vnet_get_main ();
+ u32 sw_if_index = ~0;
+ u8 enable = 0;
+
+ if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index));
+ else if (unformat (input, "enable"))
+ enable = 1;
+ else if (unformat (input, "disable"))
+ enable = 0;
+ else
+ return clib_error_return (0, "unknown input: `%U'",
+ format_unformat_error, input);
+
+ if (~0 == sw_if_index)
+ return clib_error_return (0, "specify an interface: `%U'",
+ format_unformat_error, input);
+
+ vnet_sw_interface_ip_directed_broadcast (vnm, sw_if_index, enable);
+
+ return 0;
+}
+
+/*?
+ * This command is used to enable/disable IP directed broadcast
+ * If directed broadcast is enabled a packet sent to the interface's
+ * subnet broadcast address will be sent L2 broadcast on the interface,
+ * otherwise it is dropped.
+ ?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (set_ip_directed_broadcast_command, static) = {
+ .path = "set interface ip directed-broadcast",
+ .short_help = "set interface enable <interface> <enable|disable>",
+ .function = set_ip_directed_broadcast,
+};
+/* *INDENT-ON* */
+
static clib_error_t *
set_hw_interface_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
u32 queue_id, vnet_hw_interface_rx_mode mode)
vnet_hw_interface_rx_mode old_mode;
int rv;
+ if (mode == VNET_HW_INTERFACE_RX_MODE_DEFAULT)
+ mode = hw->default_rx_mode;
+
rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &old_mode);
switch (rv)
{
break;
case VNET_API_ERROR_INVALID_INTERFACE:
return clib_error_return (0, "invalid interface");
+ case VNET_API_ERROR_INVALID_QUEUE:
+ return clib_error_return (0, "invalid queue");
default:
return clib_error_return (0, "unknown error");
}
return clib_error_return (0, "unsupported");
case VNET_API_ERROR_INVALID_INTERFACE:
return clib_error_return (0, "invalid interface");
+ case VNET_API_ERROR_INVALID_QUEUE:
+ return clib_error_return (0, "invalid queue");
default:
return clib_error_return (0, "unknown error");
}
return 0;
}
+clib_error_t *
+set_hw_interface_change_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
+ u8 queue_id_valid, u32 queue_id,
+ vnet_hw_interface_rx_mode mode)
+{
+ clib_error_t *error = 0;
+ vnet_hw_interface_t *hw;
+ int i;
+
+ hw = vnet_get_hw_interface (vnm, hw_if_index);
+
+ if (queue_id_valid == 0)
+ {
+ for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
+ {
+ error = set_hw_interface_rx_mode (vnm, hw_if_index, i, mode);
+ if (error)
+ break;
+ }
+ hw->default_rx_mode = mode;
+ }
+ else
+ error = set_hw_interface_rx_mode (vnm, hw_if_index, queue_id, mode);
+
+ return (error);
+}
+
static clib_error_t *
set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
vlib_cli_command_t * cmd)
clib_error_t *error = 0;
unformat_input_t _line_input, *line_input = &_line_input;
vnet_main_t *vnm = vnet_get_main ();
- vnet_hw_interface_t *hw;
u32 hw_if_index = (u32) ~ 0;
u32 queue_id = (u32) ~ 0;
vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
- int i;
+ u8 queue_id_valid = 0;
if (!unformat_user (input, unformat_line_input, line_input))
return 0;
(line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
;
else if (unformat (line_input, "queue %d", &queue_id))
- ;
+ queue_id_valid = 1;
else if (unformat (line_input, "polling"))
mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
else if (unformat (line_input, "interrupt"))
if (mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
return clib_error_return (0, "please specify valid rx-mode");
- hw = vnet_get_hw_interface (vnm, hw_if_index);
-
- if (queue_id == ~0)
- for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
- {
- error = set_hw_interface_rx_mode (vnm, hw_if_index, i, mode);
- if (error)
- break;
- }
- else
- error = set_hw_interface_rx_mode (vnm, hw_if_index, queue_id, mode);
+ error = set_hw_interface_change_rx_mode (vnm, hw_if_index, queue_id_valid,
+ queue_id, mode);
return (error);
}
/*?
- * This command is used to assign a given interface, and optionally a
- * given queue, to a different thread. If the '<em>queue</em>' is not provided,
- * it defaults to 0.
+ * This command is used to assign the RX packet processing mode (polling,
+ * interrupt, adaptive) of the a given interface, and optionally a
+ * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
+ * is applied to all queues of the interface. Not all interfaces support
+ * all modes. To display the current rx-mode use the command
+ * '<em>show interface rx-placement</em>'.
*
* @cliexpar
- * Example of how to display the interface placement:
+ * Example of how to assign rx-mode to all queues on an interface:
+ * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
+ * Example of how to assign rx-mode to one queue of an interface:
+ * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
+ * Example of how to display the rx-mode of all interfaces:
* @cliexstart{show interface rx-placement}
* Thread 1 (vpp_wk_0):
- * GigabitEthernet0/8/0 queue 0
- * GigabitEthernet0/9/0 queue 0
+ * node dpdk-input:
+ * GigabitEthernet7/0/0 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 0 (interrupt)
+ * VirtualEthernet0/0/12 queue 2 (polling)
+ * VirtualEthernet0/0/13 queue 0 (polling)
+ * VirtualEthernet0/0/13 queue 2 (polling)
* Thread 2 (vpp_wk_1):
- * GigabitEthernet0/8/0 queue 1
- * GigabitEthernet0/9/0 queue 1
+ * node dpdk-input:
+ * GigabitEthernet7/0/1 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 1 (polling)
+ * VirtualEthernet0/0/12 queue 3 (polling)
+ * VirtualEthernet0/0/13 queue 1 (polling)
+ * VirtualEthernet0/0/13 queue 3 (polling)
* @cliexend
- * Example of how to assign a interface and queue to a thread:
- * @cliexcmd{set interface placement GigabitEthernet0/8/0 queue 1 thread 1}
?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
vec_foreach (dq, rt->devices_and_queues)
{
+ vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm,
+ dq->hw_if_index);
s = format (s, " %U queue %u (%U)\n",
- format_vnet_sw_if_index_name, vnm, dq->hw_if_index,
+ format_vnet_sw_if_index_name, vnm, hi->sw_if_index,
dq->queue_id,
format_vnet_hw_interface_rx_mode, dq->mode);
}
}));
if (vec_len (s) > 0)
{
- vlib_cli_output(vm, "Thread %u (%v):\n%v", index,
+ vlib_cli_output(vm, "Thread %u (%s):\n%v", index,
vlib_worker_threads[index].name, s);
vec_reset_length (s);
}
return 0;
}
+/*?
+ * This command is used to display the interface and queue worker
+ * thread placement.
+ *
+ * @cliexpar
+ * Example of how to display the interface placement:
+ * @cliexstart{show interface rx-placement}
+ * Thread 1 (vpp_wk_0):
+ * node dpdk-input:
+ * GigabitEthernet7/0/0 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 0 (polling)
+ * VirtualEthernet0/0/12 queue 2 (polling)
+ * VirtualEthernet0/0/13 queue 0 (polling)
+ * VirtualEthernet0/0/13 queue 2 (polling)
+ * Thread 2 (vpp_wk_1):
+ * node dpdk-input:
+ * GigabitEthernet7/0/1 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 1 (polling)
+ * VirtualEthernet0/0/12 queue 3 (polling)
+ * VirtualEthernet0/0/13 queue 1 (polling)
+ * VirtualEthernet0/0/13 queue 3 (polling)
+ * @cliexend
+?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
.path = "show interface rx-placement",
};
/* *INDENT-ON* */
+clib_error_t *
+set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
+ u32 thread_index, u8 is_main)
+{
+ vnet_main_t *vnm = vnet_get_main ();
+ vnet_device_main_t *vdm = &vnet_device_main;
+ clib_error_t *error = 0;
+ vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
+ int rv;
+
+ if (is_main)
+ thread_index = 0;
+ else
+ thread_index += vdm->first_worker_thread_index;
+
+ if (thread_index > vdm->last_worker_thread_index)
+ return clib_error_return (0,
+ "please specify valid worker thread or main");
+
+ rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &mode);
+
+ if (rv)
+ return clib_error_return (0, "not found");
+
+ rv = vnet_hw_interface_unassign_rx_thread (vnm, hw_if_index, queue_id);
+
+ if (rv)
+ return clib_error_return (0, "not found");
+
+ vnet_hw_interface_assign_rx_thread (vnm, hw_if_index, queue_id,
+ thread_index);
+ vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
+
+ return (error);
+}
+
static clib_error_t *
set_interface_rx_placement (vlib_main_t * vm, unformat_input_t * input,
vlib_cli_command_t * cmd)
clib_error_t *error = 0;
unformat_input_t _line_input, *line_input = &_line_input;
vnet_main_t *vnm = vnet_get_main ();
- vnet_device_main_t *vdm = &vnet_device_main;
- vnet_hw_interface_rx_mode mode;
u32 hw_if_index = (u32) ~ 0;
u32 queue_id = (u32) 0;
u32 thread_index = (u32) ~ 0;
- int rv;
+ u8 is_main = 0;
if (!unformat_user (input, unformat_line_input, line_input))
return 0;
else if (unformat (line_input, "queue %d", &queue_id))
;
else if (unformat (line_input, "main", &thread_index))
- thread_index = 0;
+ is_main = 1;
else if (unformat (line_input, "worker %d", &thread_index))
- thread_index += vdm->first_worker_thread_index;
+ ;
else
{
error = clib_error_return (0, "parse error: '%U'",
if (hw_if_index == (u32) ~ 0)
return clib_error_return (0, "please specify valid interface name");
- if (thread_index > vdm->last_worker_thread_index)
- return clib_error_return (0,
- "please specify valid worker thread or main");
-
- rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &mode);
-
- if (rv)
- return clib_error_return (0, "not found");
+ error = set_hw_interface_rx_placement (hw_if_index, queue_id, thread_index,
+ is_main);
- rv = vnet_hw_interface_unassign_rx_thread (vnm, hw_if_index, queue_id);
-
- if (rv)
- return clib_error_return (0, "not found");
-
- vnet_hw_interface_assign_rx_thread (vnm, hw_if_index, queue_id,
- thread_index);
- vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
-
- return 0;
+ return (error);
}
/*?
* This command is used to assign a given interface, and optionally a
* given queue, to a different thread. If the '<em>queue</em>' is not provided,
- * it defaults to 0.
+ * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
+ * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
*
* @cliexpar
* Example of how to display the interface placement:
- * @cliexstart{show interface placement}
+ * @cliexstart{show interface rx-placement}
+ * Thread 1 (vpp_wk_0):
+ * node dpdk-input:
+ * GigabitEthernet7/0/0 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 0 (polling)
+ * VirtualEthernet0/0/12 queue 2 (polling)
+ * VirtualEthernet0/0/13 queue 0 (polling)
+ * VirtualEthernet0/0/13 queue 2 (polling)
+ * Thread 2 (vpp_wk_1):
+ * node dpdk-input:
+ * GigabitEthernet7/0/1 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 1 (polling)
+ * VirtualEthernet0/0/12 queue 3 (polling)
+ * VirtualEthernet0/0/13 queue 1 (polling)
+ * VirtualEthernet0/0/13 queue 3 (polling)
+ * @cliexend
+ * Example of how to assign a interface and queue to a worker thread:
+ * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
+ * Example of how to display the interface placement:
+ * @cliexstart{show interface rx-placement}
* Thread 1 (vpp_wk_0):
- * GigabitEthernet0/8/0 queue 0
- * GigabitEthernet0/9/0 queue 0
+ * node dpdk-input:
+ * GigabitEthernet7/0/0 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 0 (polling)
+ * VirtualEthernet0/0/12 queue 1 (polling)
+ * VirtualEthernet0/0/12 queue 2 (polling)
+ * VirtualEthernet0/0/13 queue 0 (polling)
+ * VirtualEthernet0/0/13 queue 2 (polling)
* Thread 2 (vpp_wk_1):
- * GigabitEthernet0/8/0 queue 1
- * GigabitEthernet0/9/0 queue 1
+ * node dpdk-input:
+ * GigabitEthernet7/0/1 queue 0 (polling)
+ * node vhost-user-input:
+ * VirtualEthernet0/0/12 queue 3 (polling)
+ * VirtualEthernet0/0/13 queue 1 (polling)
+ * VirtualEthernet0/0/13 queue 3 (polling)
* @cliexend
- * Example of how to assign a interface and queue to a thread:
- * @cliexcmd{set interface placement GigabitEthernet0/8/0 queue 1 thread 1}
?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
.path = "set interface rx-placement",
- .short_help = "set interface rx-placement <hw-interface> [queue <n>] [thread <n> | main]",
+ .short_help = "set interface rx-placement <interface> [queue <n>] "
+ "[worker <n> | main]",
.function = set_interface_rx_placement,
+ .is_mp_safe = 1,
};
+/* *INDENT-ON* */
+
+static u8 *
+format_vnet_pcap (u8 * s, va_list * args)
+{
+ vnet_pcap_t *pp = va_arg (*args, vnet_pcap_t *);
+ int type = va_arg (*args, int);
+ int printed = 0;
+
+ if (type == 0)
+ {
+ if (pp->pcap_rx_enable)
+ {
+ s = format (s, "rx");
+ printed = 1;
+ }
+ if (pp->pcap_tx_enable)
+ {
+ if (printed)
+ s = format (s, " and ");
+ s = format (s, "tx");
+ printed = 1;
+ }
+ if (pp->pcap_drop_enable)
+ {
+ if (printed)
+ s = format (s, " and ");
+ s = format (s, "drop");
+ printed = 1;
+ }
+ return s;
+ }
+ s = format (s, "unknown type %d!", type);
+ return s;
+}
+
+
+int
+vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
+{
+ vlib_main_t *vm = vlib_get_main ();
+ vnet_pcap_t *pp = &vm->pcap;
+ pcap_main_t *pm = &pp->pcap_main;
+ vnet_classify_main_t *cm = &vnet_classify_main;
+ vnet_classify_filter_set_t *set = 0;
+
+ if (a->status)
+ {
+ if (pp->pcap_rx_enable || pp->pcap_tx_enable || pp->pcap_drop_enable)
+ {
+ vlib_cli_output
+ (vm, "pcap %U dispatch capture enabled: %d of %d pkts...",
+ format_vnet_pcap, pp, 0 /* print type */ ,
+ pm->n_packets_captured, pm->n_packets_to_capture);
+ vlib_cli_output (vm, "capture to file %s", pm->file_name);
+ }
+ else
+ vlib_cli_output (vm, "pcap dispatch capture disabled");
+
+ return 0;
+ }
+
+ /* Consistency checks */
+
+ /* Enable w/ capture already enabled not allowed */
+ if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
+ && (a->rx_enable + a->tx_enable + a->drop_enable))
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ /* Disable capture with capture already disabled, not interesting */
+ if (((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable) == 0)
+ && ((a->rx_enable + a->tx_enable + a->drop_enable == 0)))
+ return VNET_API_ERROR_VALUE_EXIST;
+
+ /* Change number of packets to capture while capturing */
+ if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
+ && (a->rx_enable + a->tx_enable + a->drop_enable)
+ && (pm->n_packets_to_capture != a->packets_to_capture))
+ return VNET_API_ERROR_INVALID_VALUE_2;
+
+ set = pool_elt_at_index (cm->filter_sets, cm->filter_set_by_sw_if_index[0]);
+
+ /* Classify filter specified, but no classify filter configured */
+ if ((a->rx_enable + a->tx_enable + a->drop_enable) && a->filter &&
+ (set->table_indices[0] == ~0))
+ return VNET_API_ERROR_NO_SUCH_LABEL;
+
+ if (a->rx_enable + a->tx_enable + a->drop_enable)
+ {
+ /* Sanity check max bytes per pkt */
+ if (a->max_bytes_per_pkt < 32 || a->max_bytes_per_pkt > 9000)
+ return VNET_API_ERROR_INVALID_MEMORY_SIZE;
+ /* Clean up from previous run, if any */
+ vec_free (pm->file_name);
+ vec_free (pm->pcap_data);
+ memset (pm, 0, sizeof (*pm));
+
+ vec_validate_aligned (vnet_trace_dummy, 2048, CLIB_CACHE_LINE_BYTES);
+ if (pm->lock == 0)
+ clib_spinlock_init (&(pm->lock));
+
+ if (a->filename == 0)
+ {
+ u8 *stem = 0;
+
+ if (a->rx_enable)
+ stem = format (stem, "rx");
+ if (a->tx_enable)
+ stem = format (stem, "tx");
+ if (a->drop_enable)
+ stem = format (stem, "drop");
+ a->filename = format (0, "/tmp/%s.pcap%c", stem, 0);
+ vec_free (stem);
+ }
+
+ pm->file_name = (char *) a->filename;
+ pm->n_packets_captured = 0;
+ pm->packet_type = PCAP_PACKET_TYPE_ethernet;
+ pm->n_packets_to_capture = a->packets_to_capture;
+ pp->pcap_sw_if_index = a->sw_if_index;
+ if (a->filter)
+ pp->filter_classify_table_index = set->table_indices[0];
+ else
+ pp->filter_classify_table_index = ~0;
+ pp->pcap_rx_enable = a->rx_enable;
+ pp->pcap_tx_enable = a->tx_enable;
+ pp->pcap_drop_enable = a->drop_enable;
+ pp->max_bytes_per_pkt = a->max_bytes_per_pkt;
+ }
+ else
+ {
+ pp->pcap_rx_enable = 0;
+ pp->pcap_tx_enable = 0;
+ pp->pcap_drop_enable = 0;
+ pp->filter_classify_table_index = ~0;
+ if (pm->n_packets_captured)
+ {
+ clib_error_t *error;
+ pm->n_packets_to_capture = pm->n_packets_captured;
+ vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
+ pm->n_packets_captured, pm->file_name);
+ error = pcap_write (pm);
+ if (pm->flags & PCAP_MAIN_INIT_DONE)
+ pcap_close (pm);
+ /* Report I/O errors... */
+ if (error)
+ {
+ clib_error_report (error);
+ return VNET_API_ERROR_SYSCALL_ERROR_1;
+ }
+ return 0;
+ }
+ else
+ return VNET_API_ERROR_NO_SUCH_ENTRY;
+ }
+
+ return 0;
+}
+
+static clib_error_t *
+pcap_trace_command_fn (vlib_main_t * vm,
+ unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+ unformat_input_t _line_input, *line_input = &_line_input;
+ vnet_pcap_dispatch_trace_args_t _a, *a = &_a;
+ vnet_main_t *vnm = vnet_get_main ();
+ u8 *filename = 0;
+ u32 max = 1000;
+ u32 max_bytes_per_pkt = 512;
+ int rv;
+ int rx_enable = 0;
+ int tx_enable = 0;
+ int drop_enable = 0;
+ int status = 0;
+ int filter = 0;
+ u32 sw_if_index = ~0;
+
+ /* Get a line of input. */
+ if (!unformat_user (input, unformat_line_input, line_input))
+ return 0;
+
+ while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
+ {
+ if (unformat (line_input, "rx"))
+ rx_enable = 1;
+ else if (unformat (line_input, "tx"))
+ tx_enable = 1;
+ else if (unformat (line_input, "drop"))
+ drop_enable = 1;
+ else if (unformat (line_input, "off"))
+ rx_enable = tx_enable = drop_enable = 0;
+ else if (unformat (line_input, "max-bytes-per-pkt %u",
+ &max_bytes_per_pkt))
+ ;
+ else if (unformat (line_input, "max %d", &max))
+ ;
+ else if (unformat (line_input, "packets-to-capture %d", &max))
+ ;
+ else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
+ &filename))
+ ;
+ else if (unformat (line_input, "status %=", &status, 1))
+ ;
+ else if (unformat (line_input, "intfc %U",
+ unformat_vnet_sw_interface, vnm, &sw_if_index))
+ ;
+ else if (unformat (line_input, "intfc any"))
+ sw_if_index = 0;
+ else if (unformat (line_input, "filter"))
+ filter = 1;
+ else
+ {
+ return clib_error_return (0, "unknown input `%U'",
+ format_unformat_error, line_input);
+ }
+ }
+
+ unformat_free (line_input);
+
+ /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
+ a->filename = filename;
+ a->rx_enable = rx_enable;
+ a->tx_enable = tx_enable;
+ a->drop_enable = drop_enable;
+ a->status = status;
+ a->packets_to_capture = max;
+ a->sw_if_index = sw_if_index;
+ a->filter = filter;
+ a->max_bytes_per_pkt = max_bytes_per_pkt;
+
+ rv = vnet_pcap_dispatch_trace_configure (a);
+
+ switch (rv)
+ {
+ case 0:
+ break;
+
+ case VNET_API_ERROR_INVALID_VALUE:
+ return clib_error_return (0, "dispatch trace already enabled...");
+
+ case VNET_API_ERROR_VALUE_EXIST:
+ return clib_error_return (0, "dispatch trace already disabled...");
+
+ case VNET_API_ERROR_INVALID_VALUE_2:
+ return clib_error_return
+ (0, "can't change number of records to capture while tracing...");
+
+ case VNET_API_ERROR_SYSCALL_ERROR_1:
+ return clib_error_return (0, "I/O writing trace capture...");
+
+ case VNET_API_ERROR_NO_SUCH_ENTRY:
+ return clib_error_return (0, "No packets captured...");
+
+ case VNET_API_ERROR_INVALID_MEMORY_SIZE:
+ return clib_error_return (0,
+ "Max bytes per pkt must be > 32, < 9000...");
+
+ case VNET_API_ERROR_NO_SUCH_LABEL:
+ return clib_error_return
+ (0, "No classify filter configured, see 'classify filter...'");
+
+ default:
+ vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
+ break;
+ }
+ return 0;
+}
+
+/*?
+ * This command is used to start or stop a packet capture, or show
+ * the status of packet capture.
+ *
+ * This command has the following optional parameters:
+ *
+ *
+ * - <b>rx</b> - Capture received packets
+ *
+ * - <b>tx</b> - Capture transmitted packets
+ *
+ * - <b>drop</b> - Capture dropped packets
+ *
+ * - <b>off</b> - Stop capturing packets, write results to the specified file
+ *
+ * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
+ * of packets have been received, buffer is flushed to file. Once another
+ * '<em>nn</em>' number of packets have been received, buffer is flushed
+ * to file, overwriting previous write. If not entered, value defaults
+ * to 100. Can only be updated if packet capture is off.
+ *
+ * - <b>max-bytes-per-pkt <nnnn></b> - Maximum number of bytes to capture
+ * for each packet. Must be >= 32, <= 9000.
+ *
+ * - <b>intfc <interface-name>|any</b> - Used to specify a given interface,
+ * or use '<em>any</em>' to run packet capture on all interfaces.
+ * '<em>any</em>' is the default if not provided. Settings from a previous
+ * packet capture are preserved, so '<em>any</em>' can be used to reset
+ * the interface setting.
+ *
+ * - <b>filter</b> - Use the pcap rx / tx / drop trace filter, which
+ * must be configured. Use <b>classify filter pcap...</b> to configure the
+ * filter. The filter will only be executed if the per-interface or
+ * any-interface tests fail.
+ *
+ * - <b>file <name></b> - Used to specify the output filename. The file will
+ * be placed in the '<em>/tmp</em>' directory, so only the filename is
+ * supported. Directory should not be entered. If file already exists, file
+ * will be overwritten. If no filename is provided, the file will be
+ * named "/tmp/rx.pcap", "/tmp/tx.pcap", "/tmp/rxandtx.pcap", etc.
+ * Can only be updated if packet capture is off.
+ *
+ * - <b>status</b> - Displays the current status and configured attributes
+ * associated with a packet capture. If packet capture is in progress,
+ * '<em>status</em>' also will return the number of packets currently in
+ * the local buffer. All additional attributes entered on command line
+ * with '<em>status</em>' will be ignored and not applied.
+ *
+ * @cliexpar
+ * Example of how to display the status of a tx packet capture when off:
+ * @cliexstart{pcap trace status}
+ * max is 100, for any interface to file /tmp/vpe.pcap
+ * pcap tx capture is off...
+ * @cliexend
+ * Example of how to start a tx packet capture:
+ * @cliexstart{pcap trace tx max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
+ * @cliexend
+ * Example of how to display the status of a tx packet capture in progress:
+ * @cliexstart{pcap trace status}
+ * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
+ * pcap tx capture is on: 20 of 35 pkts...
+ * @cliexend
+ * Example of how to stop a tx packet capture:
+ * @cliexstart{pcap trace off}
+ * captured 21 pkts...
+ * saved to /tmp/vppTest.pcap...
+ * @cliexend
+?*/
+/* *INDENT-OFF* */
+
+VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
+ .path = "pcap trace",
+ .short_help =
+ "pcap trace rx tx drop off [max <nn>] [intfc <interface>|any] [file <name>] [status] [max-bytes-per-pkt <nnnn>][filter]",
+ .function = pcap_trace_command_fn,
+};
/* *INDENT-ON* */
+
/*
* fd.io coding-style-patch-verification: ON
*
Code Review / vpp.git / blobdiff