+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_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
+ vnet_device_class_t *dev_class =
+ vnet_get_device_class (vnm, hw->dev_class_index);
+ clib_error_t *error;
+ 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)
+ {
+ case 0:
+ if (old_mode == mode)
+ return 0; /* same rx-mode, no change */
+ 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");
+ }
+
+ if (dev_class->rx_mode_change_function)
+ {
+ error = dev_class->rx_mode_change_function (vnm, hw_if_index, queue_id,
+ mode);
+ if (error)
+ return (error);
+ }
+
+ rv = vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
+ switch (rv)
+ {
+ case 0:
+ break;
+ case VNET_API_ERROR_UNSUPPORTED:
+ 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 ();
+ u32 hw_if_index = (u32) ~ 0;
+ u32 queue_id = (u32) ~ 0;
+ vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
+ u8 queue_id_valid = 0;
+
+ 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, "%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"))
+ mode = VNET_HW_INTERFACE_RX_MODE_INTERRUPT;
+ else if (unformat (line_input, "adaptive"))
+ mode = VNET_HW_INTERFACE_RX_MODE_ADAPTIVE;
+ else
+ {
+ error = clib_error_return (0, "parse error: '%U'",
+ format_unformat_error, line_input);
+ unformat_free (line_input);
+ return error;
+ }
+ }
+
+ unformat_free (line_input);
+
+ if (hw_if_index == (u32) ~ 0)
+ return clib_error_return (0, "please specify valid interface name");
+
+ if (mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
+ return clib_error_return (0, "please specify valid rx-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 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 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):
+ * 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):
+ * 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 (cmd_set_if_rx_mode,static) = {
+ .path = "set interface rx-mode",
+ .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
+ .function = set_interface_rx_mode,
+};
+/* *INDENT-ON* */
+
+static clib_error_t *
+show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
+ vlib_cli_command_t * cmd)
+{
+ u8 *s = 0;
+ vnet_main_t *vnm = vnet_get_main ();
+ vnet_device_input_runtime_t *rt;
+ vnet_device_and_queue_t *dq;
+ vlib_node_t *pn = vlib_get_node_by_name (vm, (u8 *) "device-input");
+ uword si;
+ int index = 0;
+
+ /* *INDENT-OFF* */
+ foreach_vlib_main (({
+ clib_bitmap_foreach (si, pn->sibling_bitmap,
+ ({
+ rt = vlib_node_get_runtime_data (this_vlib_main, si);
+
+ if (vec_len (rt->devices_and_queues))
+ s = format (s, " node %U:\n", format_vlib_node_name, vm, si);
+
+ 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, 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 (%s):\n%v", index,
+ vlib_worker_threads[index].name, s);
+ vec_reset_length (s);
+ }
+ index++;
+ }));
+ /* *INDENT-ON* */
+
+ vec_free (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",
+ .short_help = "show interface rx-placement",
+ .function = show_interface_rx_placement_fn,
+};
+/* *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 ();
+ u32 hw_if_index = (u32) ~ 0;
+ u32 queue_id = (u32) 0;
+ u32 thread_index = (u32) ~ 0;
+ u8 is_main = 0;
+
+ 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, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
+ ;
+ else if (unformat (line_input, "queue %d", &queue_id))
+ ;
+ else if (unformat (line_input, "main", &thread_index))
+ is_main = 1;
+ else if (unformat (line_input, "worker %d", &thread_index))
+ ;
+ else
+ {
+ error = clib_error_return (0, "parse error: '%U'",
+ format_unformat_error, line_input);
+ unformat_free (line_input);
+ return error;
+ }
+ }
+
+ unformat_free (line_input);
+
+ if (hw_if_index == (u32) ~ 0)
+ return clib_error_return (0, "please specify valid interface name");
+
+ error = set_hw_interface_rx_placement (hw_if_index, queue_id, thread_index,
+ is_main);
+
+ 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. 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 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):
+ * 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):
+ * 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
+?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
+ .path = "set interface rx-placement",
+ .short_help = "set interface rx-placement <interface> [queue <n>] "
+ "[worker <n> | main]",
+ .function = set_interface_rx_placement,
+ .is_mp_safe = 1,
+};
+/* *INDENT-ON* */
+
+static inline clib_error_t *
+pcap_trace_command_internal (vlib_main_t * vm,
+ unformat_input_t * input,
+ vlib_cli_command_t * cmd, int rx_tx)
+{
+#define PCAP_DEF_PKT_TO_CAPTURE (1000)
+
+ unformat_input_t _line_input, *line_input = &_line_input;
+ u8 *filename;
+ u8 *chroot_filename = 0;
+ u32 max = 0;
+ int enabled = 0;
+ int errorFlag = 0;
+ clib_error_t *error = 0;
+ vnet_main_t *vnm = vnet_get_main ();
+
+ /* 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, "on"))
+ {
+ if (vm->pcap[rx_tx].pcap_enable == 0)
+ {
+ enabled = 1;
+ }
+ else
+ {
+ vlib_cli_output (vm, "pcap tx capture already on...");
+ errorFlag = 1;
+ break;
+ }
+ }
+ else if (unformat (line_input, "off"))
+ {
+ if (vm->pcap[rx_tx].pcap_enable)
+ {
+ vlib_cli_output
+ (vm, "captured %d pkts...",
+ vm->pcap[rx_tx].pcap_main.n_packets_captured);
+ if (vm->pcap[rx_tx].pcap_main.n_packets_captured)
+ {
+ vm->pcap[rx_tx].pcap_main.n_packets_to_capture =
+ vm->pcap[rx_tx].pcap_main.n_packets_captured;
+ error = pcap_write (&vm->pcap[rx_tx].pcap_main);
+ if (error)
+ clib_error_report (error);
+ else
+ vlib_cli_output (vm, "saved to %s...",
+ vm->pcap[rx_tx].pcap_main.file_name);
+ }
+
+ vm->pcap[rx_tx].pcap_enable = 0;
+ }
+ else
+ {
+ vlib_cli_output (vm, "pcap tx capture already off...");
+ errorFlag = 1;
+ break;
+ }
+ }
+ else if (unformat (line_input, "max %d", &max))
+ {
+ if (vm->pcap[rx_tx].pcap_enable)
+ {
+ vlib_cli_output
+ (vm,
+ "can't change max value while pcap tx capture active...");
+ errorFlag = 1;
+ break;
+ }
+ vm->pcap[rx_tx].pcap_main.n_packets_to_capture = max;
+ }
+ else if (unformat (line_input, "intfc %U",
+ unformat_vnet_sw_interface, vnm,
+ &vm->pcap[rx_tx].pcap_sw_if_index))
+ ;
+
+ else if (unformat (line_input, "intfc any"))
+ {
+ vm->pcap[rx_tx].pcap_sw_if_index = 0;
+ }
+ else if (unformat (line_input, "file %s", &filename))
+ {
+ if (vm->pcap[rx_tx].pcap_enable)
+ {
+ vlib_cli_output
+ (vm, "can't change file while pcap tx capture active...");
+ errorFlag = 1;
+ break;
+ }
+
+ /* Brain-police user path input */
+ if (strstr ((char *) filename, "..")
+ || index ((char *) filename, '/'))
+ {
+ vlib_cli_output (vm, "illegal characters in filename '%s'",
+ filename);
+ vlib_cli_output (vm, "Hint: .. and / are not allowed.");
+ vec_free (filename);
+ errorFlag = 1;
+ break;
+ }
+
+ chroot_filename = format (0, "/tmp/%s%c", filename, 0);
+ vec_free (filename);
+ }
+ else if (unformat (line_input, "status"))
+ {
+ if (vm->pcap[rx_tx].pcap_sw_if_index == 0)
+ {
+ vlib_cli_output
+ (vm, "max is %d for any interface to file %s",
+ vm->pcap[rx_tx].pcap_main.n_packets_to_capture ?
+ vm->pcap[rx_tx].pcap_main.n_packets_to_capture
+ : PCAP_DEF_PKT_TO_CAPTURE,
+ vm->pcap[rx_tx].pcap_main.file_name ?
+ (u8 *) vm->pcap[rx_tx].pcap_main.file_name :
+ (u8 *) "/tmp/vpe.pcap");
+ }
+ else
+ {
+ vlib_cli_output (vm, "max is %d for interface %U to file %s",
+ vm->pcap[rx_tx].pcap_main.n_packets_to_capture
+ ? vm->pcap[rx_tx].
+ pcap_main.n_packets_to_capture :
+ PCAP_DEF_PKT_TO_CAPTURE,
+ format_vnet_sw_if_index_name, vnm,
+ vm->pcap_sw_if_index,
+ vm->pcap[rx_tx].
+ pcap_main.file_name ? (u8 *) vm->pcap[rx_tx].
+ pcap_main.file_name : (u8 *) "/tmp/vpe.pcap");
+ }
+
+ if (vm->pcap[rx_tx].pcap_enable == 0)
+ {
+ vlib_cli_output (vm, "pcap %s capture is off...",
+ (rx_tx == VLIB_RX) ? "rx" : "tx");
+ }
+ else
+ {
+ vlib_cli_output (vm, "pcap %s capture is on: %d of %d pkts...",
+ (rx_tx == VLIB_RX) ? "rx" : "tx",
+ vm->pcap[rx_tx].pcap_main.n_packets_captured,
+ vm->pcap[rx_tx].
+ pcap_main.n_packets_to_capture);
+ }
+ break;
+ }
+
+ else
+ {
+ error = clib_error_return (0, "unknown input `%U'",
+ format_unformat_error, line_input);
+ errorFlag = 1;
+ break;
+ }
+ }
+ unformat_free (line_input);
+
+
+ if (errorFlag == 0)
+ {
+ /* Since no error, save configured values. */
+ if (chroot_filename)
+ {
+ if (vm->pcap[rx_tx].pcap_main.file_name)
+ vec_free (vm->pcap[rx_tx].pcap_main.file_name);
+ vec_add1 (chroot_filename, 0);
+ vm->pcap[rx_tx].pcap_main.file_name = (char *) chroot_filename;
+ }
+
+ if (max)
+ vm->pcap[rx_tx].pcap_main.n_packets_to_capture = max;
+
+ if (enabled)
+ {
+ if (vm->pcap[rx_tx].pcap_main.file_name == 0)
+ vm->pcap[rx_tx].pcap_main.file_name
+ = (char *) format (0, "/tmp/vpe.pcap%c", 0);
+
+ vm->pcap[rx_tx].pcap_main.n_packets_captured = 0;
+ vm->pcap[rx_tx].pcap_main.packet_type = PCAP_PACKET_TYPE_ethernet;
+ if (vm->pcap[rx_tx].pcap_main.lock == 0)
+ clib_spinlock_init (&(vm->pcap[rx_tx].pcap_main.lock));
+ vm->pcap[rx_tx].pcap_enable = 1;
+ vlib_cli_output (vm, "pcap %s capture on...",
+ rx_tx == VLIB_RX ? "rx" : "tx");
+ }
+ }
+ else if (chroot_filename)
+ vec_free (chroot_filename);
+
+ return error;
+}
+
+static clib_error_t *
+pcap_rx_trace_command_fn (vlib_main_t * vm,
+ unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+ return pcap_trace_command_internal (vm, input, cmd, VLIB_RX);
+}
+
+static clib_error_t *
+pcap_tx_trace_command_fn (vlib_main_t * vm,
+ unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+ return pcap_trace_command_internal (vm, input, cmd, VLIB_TX);
+}
+
+
+/*?
+ * This command is used to start or stop a packet capture, or show
+ * the status of packet capture. Note that both "pcap rx trace" and
+ * "pcap tx trace" are implemented. The command syntax is identical,
+ * simply substitute rx for tx as needed.
+ *
+ * This command has the following optional parameters:
+ *
+ * - <b>on|off</b> - Used to start or stop a packet capture.
+ *
+ * - <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>intfc <interface>|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>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, '<em>/tmp/vpe.pcap</em>'
+ * will be used. 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 tx 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 tx trace on max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
+ * pcap tx capture on...
+ * @cliexend
+ * Example of how to display the status of a tx packet capture in progress:
+ * @cliexstart{pcap tx 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{vppctl pcap tx trace off}
+ * captured 21 pkts...
+ * saved to /tmp/vppTest.pcap...
+ * @cliexend
+?*/
+/* *INDENT-OFF* */
+
+VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
+ .path = "pcap tx trace",
+ .short_help =
+ "pcap tx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
+ .function = pcap_tx_trace_command_fn,
+};
+VLIB_CLI_COMMAND (pcap_rx_trace_command, static) = {
+ .path = "pcap rx trace",
+ .short_help =
+ "pcap rx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
+ .function = pcap_rx_trace_command_fn,
+};
+/* *INDENT-ON* */
+