VLIB application library

clear

Summary/usage

Clear commands.

Declaration and implementation

Declaration: vlib_cli_clear_command (src/vlib/cli.c line 66)

clear errors

Summary/usage

Clear error counters.

Declaration and implementation

Declaration: cli_clear_error_counters (src/vlib/error.c line 319)

Implementation: clear_error_counters.

clear logging

Summary/usage

clear logging.

Declaration and implementation

Declaration: cli_clear_log (src/vlib/log.c line 372)

Implementation: clear_log.

clear node counters

Summary/usage

Clear node counters.

Declaration and implementation

Declaration: cli_clear_node_counters (src/vlib/error.c line 327)

Implementation: clear_error_counters.

clear runtime

Summary/usage

Clear packet processing runtime statistics.

Declaration and implementation

Declaration: clear_node_runtime_command (src/vlib/node_cli.c line 537)

Implementation: clear_node_runtime.

clear trace

Summary/usage

Clear trace buffer and free memory.

Declaration and implementation

Declaration: clear_trace_cli (src/vlib/trace.c line 551)

Implementation: cli_clear_trace_buffer.

elog trace

Summary/usage

elog trace [api][cli][barrier][dispatch]

[circuit-node <name> e.g. ethernet-input][disable].

Description

Control event logging of api, cli, and thread barrier events With no arguments, displays the current trace status. Name the event groups you wish to trace or stop tracing.

Example usage

elog trace api cli barrier
elog trace api cli barrier disable
elog trace dispatch
elog trace circuit-node ethernet-input
elog trace

vpp# elog trace [api][cli][barrier][disable]

Declaration and implementation

Declaration: elog_trace_command (src/vlib/cli.c line 1544)

Implementation: elog_trace_command_fn.

event-logger clear

Summary/usage

Clear the event log.

Declaration and implementation

Declaration: elog_clear_cli (src/vlib/main.c line 691)

Implementation: vlib_cli_elog_clear.

event-logger resize

Summary/usage

event-logger resize <nnn>.

Declaration and implementation

Declaration: elog_resize_cli (src/vlib/main.c line 825)

Implementation: elog_resize.

event-logger restart

Summary/usage

Restart the event-logger.

Declaration and implementation

Declaration: elog_restart_cli (src/vlib/main.c line 795)

Implementation: elog_restart.

event-logger save

Summary/usage

event-logger save <filename> (saves log in /tmp/<filename>).

Declaration and implementation

Declaration: elog_save_cli (src/vlib/main.c line 755)

Implementation: elog_save_buffer.

event-logger stop

Summary/usage

Stop the event-logger.

Declaration and implementation

Declaration: elog_stop_cli (src/vlib/main.c line 775)

Implementation: elog_stop.

memory-trace

Summary/usage

memory-trace on|off [api-segment][stats-segment][main-heap]
               [numa-heap <numa-id>]

Declaration and implementation

Declaration: enable_disable_memory_trace_command (src/vlib/cli.c line 1025)

Implementation: enable_disable_memory_trace.

pcap dispatch trace

Summary/usage

pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]
          [buffer-trace <input-node-name> <nn>].

Description

This command is used to start or stop pcap dispatch trace capture, or show the capture status.

This command has the following optional parameters:

• <b>on|off</b> - Used to start or stop capture.
• <b>max <nn></b> - Depth of local buffer. Once &#39;<em>nn</em>&#39; number of packets have been received, buffer is flushed to file. Once another &#39;<em>nn</em>&#39; 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>file <name></b> - Used to specify the output filename. The file will be placed in the &#39;<em>/tmp</em>&#39; 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, &#39;<em>/tmp/vpe.pcap</em>&#39; 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, &#39;<em>status</em>&#39; also will return the number of packets currently in the local buffer. All additional attributes entered on command line with &#39;<em>status</em>&#39; will be ignored and not applied.

Example usage

Example of how to display the status of capture when off:

vpp# pcap dispatch trace status

max is 100, for any interface to file /tmp/vpe.pcap
pcap dispatch capture is off...

Example of how to start a dispatch trace capture:

vpp# pcap dispatch trace on max 35 file dispatchTrace.pcap

pcap dispatch capture on...

Example of how to start a dispatch trace capture with buffer tracing

vpp# pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000

pcap dispatch capture on...

Example of how to display the status of a tx packet capture in progress:

vpp# pcap tx trace status

max is 35, dispatch trace to file /tmp/vppTest.pcap
pcap tx capture is on: 20 of 35 pkts...

Example of how to stop a tx packet capture:

vpp# vppctl pcap dispatch trace off

captured 21 pkts...
saved to /tmp/dispatchTrace.pcap...

Declaration and implementation

Declaration: pcap_dispatch_trace_command (src/vlib/main.c line 2493)

Implementation: dispatch_trace_command_fn.

restart

Summary/usage

restart process.

Declaration and implementation

Declaration: restart_cmd (src/vlib/cli.c line 1059)

Implementation: restart_cmd_fn.

set

Summary/usage

Set commands.

Declaration and implementation

Declaration: vlib_cli_set_command (src/vlib/cli.c line 74)

set logging class

Summary/usage

set logging class <class> [rate-limit <int>] [level <level>] [syslog-level <level>].

Declaration and implementation

Declaration: cli_set_log (src/vlib/log.c line 506)

Implementation: set_log_class.

set logging size

Summary/usage

set logging size <int>.

Declaration and implementation

Declaration: cli_set_log_size (src/vlib/log.c line 576)

Implementation: set_log_size.

set logging unthrottle-time

Summary/usage

set logging unthrottle-time <int>.

Declaration and implementation

Declaration: cli_set_log_params (src/vlib/log.c line 540)

Implementation: set_log_unth_time.

set node function

Summary/usage

set node function <node-name> <variant-name>.

Declaration and implementation

Declaration: set_node_fn_command (src/vlib/node_cli.c line 775)

Implementation: set_node_fn.

show

Summary/usage

Show commands.

Declaration and implementation

Declaration: vlib_cli_show_command (src/vlib/cli.c line 58)

show buffers

Summary/usage

Show packet buffer allocation.

Declaration and implementation

Declaration: show_buffers_command (src/vlib/buffer.c line 659)

Implementation: show_buffers.

show cli

Summary/usage

show cli [mp-safe][not-mp-safe][hit][clear-hit].

Description

Displays debug cli command information

Example usage

vpp# show cli [mp-safe][not-mp-safe][hit][clear-hit]

&#34;show cli&#34; displays the entire debug cli:

abf attach
abf policy
adjacency counters
api trace
app ns
bfd key del
... and so on ...

"show cli mp-safe" displays mp-safe debug CLI commands:

abf policy
binary-api
create vhost-user
exec
ip container
ip mroute
ip probe-neighbor
ip route
ip scan-neighbor
ip table
ip6 table

"show cli not-mp-safe" displays debug CLI commands
which cause worker thread barrier synchronization

"show cli hit" displays commands which have been executed. Qualify
as desired with "mp-safe" or "not-mp-safe".

"show cli clear-hit" clears the per-command hit counters.

Declaration and implementation

Declaration: show_cli_command (src/vlib/cli.c line 1760)

Implementation: show_cli_command_fn.

show clock

Summary/usage

show clock.

Declaration and implementation

Declaration: f_command (src/vlib/threads.c line 1998)

Implementation: show_clock_command_fn.

show cpu

Summary/usage

Show cpu information.

Description

Displays various information about the CPU.

Example usage

vpp# show cpu

Model name:               Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
Microarchitecture:        Broadwell (Broadwell-EP/EX)
Flags:                    sse3 ssse3 sse41 sse42 avx avx2 aes
Base Frequency:           3.20 GHz

Declaration and implementation

Declaration: show_cpu_command (src/vlib/cli.c line 912)

Implementation: show_cpu.

show errors

Summary/usage

Show error counts.

Declaration and implementation

Declaration: vlib_cli_show_errors (src/vlib/error.c line 285)

Implementation: show_errors.

show event-logger

Summary/usage

Show event logger info.

Declaration and implementation

Declaration: elog_show_cli (src/vlib/main.c line 884)

Implementation: elog_show_buffer.

show frame-queue

Summary/usage

show frame-queue trace.

Declaration and implementation

Declaration: cmd_show_frame_queue_trace (src/vlib/threads_cli.c line 366)

Implementation: show_frame_queue_trace.

show frame-queue histogram

Summary/usage

show frame-queue histogram.

Declaration and implementation

Declaration: cmd_show_frame_queue_histogram (src/vlib/threads_cli.c line 374)

Implementation: show_frame_queue_histogram.

show logging

Summary/usage

show logging.

Declaration and implementation

Declaration: cli_show_log (src/vlib/log.c line 293)

Implementation: show_log.

show logging configuration

Summary/usage

show logging configuration.

Declaration and implementation

Declaration: cli_show_log_config (src/vlib/log.c line 341)

Implementation: show_log_config.

show memory

Summary/usage

show memory [api-segment][stats-segment][verbose]
        [numa-heaps].

Declaration and implementation

Declaration: show_memory_usage_command (src/vlib/cli.c line 878)

Implementation: show_memory_usage.

show node

Summary/usage

show node [index] <node-name | node-index>.

Declaration and implementation

Declaration: show_node_command (src/vlib/node_cli.c line 705)

Implementation: show_node.

show node counters

Summary/usage

Show node counters.

Declaration and implementation

Declaration: cli_show_node_counters (src/vlib/error.c line 293)

Implementation: show_errors.

show physmem

Summary/usage

show physmem [verbose | detail | map].

Declaration and implementation

Declaration: show_physmem_command (src/vlib/physmem.c line 165)

Implementation: show_physmem.

show punt client

Summary/usage

show client[s] registered with the punt infra.

Declaration and implementation

Declaration: punt_client_show_command (src/vlib/punt.c line 561)

Implementation: punt_client_show.

show punt db

Summary/usage

show the punt DB.

Declaration and implementation

Declaration: punt_db_show_command (src/vlib/punt.c line 627)

Implementation: punt_db_show.

show punt reasons

Summary/usage

show all punt reasons.

Declaration and implementation

Declaration: punt_reason_show_command (src/vlib/punt.c line 584)

Implementation: punt_reason_show.

show punt stats

Summary/usage

show the punt stats.

Declaration and implementation

Declaration: punt_stats_show_command (src/vlib/punt.c line 654)

Implementation: punt_stats_show.

show runtime

Summary/usage

Show packet processing runtime.

Declaration and implementation

Declaration: show_node_runtime_command (src/vlib/node_cli.c line 484)

Implementation: show_node_runtime.

show threads

Summary/usage

Show threads.

Declaration and implementation

Declaration: show_threads_command (src/vlib/threads_cli.c line 88)

Implementation: show_threads_fn.

show trace

Summary/usage

Show trace buffer [max COUNT].

Declaration and implementation

Declaration: show_trace_cli (src/vlib/trace.c line 347)

Implementation: cli_show_trace_buffer.

show vlib frame-allocation

Summary/usage

Show node dispatch frame statistics.

Declaration and implementation

Declaration: show_frame_stats_cli (src/vlib/main.c line 287)

Implementation: show_frame_stats.

show vlib graph

Summary/usage

Show packet processing node graph.

Declaration and implementation

Declaration: show_node_graph_command (src/vlib/node_cli.c line 87)

Implementation: show_node_graph.

show vlib graphviz

Summary/usage

Dump packet processing node graph as a graphviz dotfile.

Declaration and implementation

Declaration: show_node_graphviz_command (src/vlib/node_cli.c line 162)

Implementation: show_node_graphviz.

suspend

Summary/usage

suspend debug CLI for 30ms.

Declaration and implementation

Declaration: suspend_command (src/vlib/cli.c line 1562)

Implementation: suspend_command_fn.

test

Summary/usage

Test commands.

Declaration and implementation

Declaration: vlib_cli_test_command (src/vlib/cli.c line 82)

test frame-queue nelts

Summary/usage

test frame-queue nelts (4,8,16,32).

Declaration and implementation

Declaration: cmd_test_frame_queue_nelts (src/vlib/threads_cli.c line 449)

Implementation: test_frame_queue_nelts.

test frame-queue threshold

Summary/usage

test frame-queue threshold N (0=no limit).

Declaration and implementation

Declaration: cmd_test_frame_queue_threshold (src/vlib/threads_cli.c line 528)

Implementation: test_frame_queue_threshold.

test log

Summary/usage

test log <level> <class> <subclass> <message>.

Declaration and implementation

Declaration: cli_test_log (src/vlib/log.c line 655)

Implementation: test_log_class_subclass.

test sleep

Summary/usage

Sleep for 10 seconds.

Declaration and implementation

Declaration: ping_command (src/vlib/cli.c line 1091)

Implementation: sleep_ten_seconds.

trace

Summary/usage

Packet tracer commands.

Declaration and implementation

Declaration: trace_cli_command (src/vlib/trace.c line 172)

trace add

Summary/usage

Trace given number of packets.

Declaration and implementation

Declaration: add_trace_cli (src/vlib/trace.c line 437)

Implementation: cli_add_trace_buffer.

trace filter

Summary/usage

filter trace output - include NODE COUNT | exclude NODE COUNT | none.

Declaration and implementation

Declaration: filter_trace_cli (src/vlib/trace.c line 534)

Implementation: cli_filter_trace.

trace frame-queue

Summary/usage

trace frame-queue (on|off).

Declaration and implementation

Declaration: cmd_trace_frame_queue (src/vlib/threads_cli.c line 184)

Implementation: trace_frame_queue.