perfquery
(1m)
Name
perfquery - query InfiniBand port counters
Synopsis
perfquery [-d(ebug)] [-G(uid)] [-x|--extended] [-X|--xmtsl]
[-S|--rcvsl] [-D|--xmtdisc] [-E|--rcverr] [-c|--smplctl]
[-a(ll_ports)] [-l(oop_ports)] [-r(eset_after_read)]
[-R(eset_only)] [-C ca_name] [-P ca_port] [-t(imeout) time-
out_ms] [-V(ersion)] [-h(elp)] [<lid|guid> [[port]
[reset_mask]]]
Description
OpenIB Diagnostics PERFQUERY(1m)
NAME
perfquery - query InfiniBand port counters
SYNOPSIS
perfquery [-d(ebug)] [-G(uid)] [-x|--extended] [-X|--xmtsl]
[-S|--rcvsl] [-D|--xmtdisc] [-E|--rcverr] [-c|--smplctl]
[-a(ll_ports)] [-l(oop_ports)] [-r(eset_after_read)]
[-R(eset_only)] [-C ca_name] [-P ca_port] [-t(imeout) time-
out_ms] [-V(ersion)] [-h(elp)] [<lid|guid> [[port]
[reset_mask]]]
DESCRIPTION
perfquery uses PerfMgt GMPs to obtain the PortCounters
(basic performance and error counters), PortExtendedCoun-
ters, PortXmitDataSL, PortRcvDataSL, PortRcvErrorDetails,
PortXmitDiscardDetails, or PortSamplesControl from the PMA
at the node/port specified. Optionally shows aggregated
counters for all ports of node. Also, optionally, reset
after read, or only reset counters.
Note: In PortCounters, PortCountersExtended, PortXmitDataSL,
and PortRcvDataSL, components that represent Data (e.g.
PortXmitData and PortRcvData) indicate octets divided by 4
rather than just octets.
Note: Inputting a port of 255 indicates an operation be per-
formed on all ports.
OPTIONS
-x, --extended
show extended port counters rather than (basic) port
counters. Note that extended port counters attribute
is optional.
-X, --xmtsl
show transmit data SL counter. This is an optional
counter for QoS.
-S, --rcvsl
show receive data SL counter. This is an optional
counter for QoS.
-D, --xmtdisc
show transmit discard details. This is an optional
counter.
-E, --rcverr
show receive error details. This is an optional
counter.
OpenIB Last change: Jun 16, 2010 1
OpenIB Diagnostics PERFQUERY(1m)
-D, --xmtdisc
show transmit discard details. This is an optional
counter.
-c, --smplctl
show port samples control.
-a, --all_ports
show aggregated counters for all ports of the destina-
tion lid or reset all counters for all ports. If the
destination lid does not support the AllPortSelect
flag, all ports will be iterated through to emulate
AllPortSelect behavior.
-l, --loop_ports
If all ports are selected by the user (either through
the -a option or port 255) iterate through each port
rather than doing than aggregate operation.
-r, --reset_after_read
reset counters after read
-R, --Reset_only
only reset counters
COMMON OPTIONS
Most OpenIB diagnostics take the following common flags. The
exact list of supported flags per utility can be found in
the usage message and can be shown using the util_name -h
syntax.
# Debugging flags
-d raise the IB debugging level.
May be used several times (-ddd or -d -d -d).
-e show send and receive errors (timeouts and others)
-h show the usage message
-v increase the application verbosity level.
May be used several times (-vv or -v -v -v)
-V show the version info.
# Addressing flags
-G use GUID address argument. In most cases, it is the
Port GUID.
Example:
"0x08f1040023"
OpenIB Last change: Jun 16, 2010 2
OpenIB Diagnostics PERFQUERY(1m)
-s <smlid> use 'smlid' as the target lid for SM/SA
queries.
# Other common flags:
-C <ca_name> use the specified ca_name.
-P <ca_port> use the specified ca_port.
-t <timeout_ms> override the default timeout for the
solicited mads.
Multiple CA/Multiple Port Support
When no IB device or port is specified, the port to use is
selected by the following criteria:
1. the first port that is ACTIVE.
2. if not found, the first port that is UP (physical link
up).
If a port and/or CA name is specified, the user request is
attempted to be fulfilled, and will fail if it is not possi-
ble.
EXAMPLES
perfquery # read local port performance coun-
ters
perfquery 32 1 # read performance counters from lid
32, port 1
perfquery -x 32 1 # read extended performance counters
from lid 32, port 1
perfquery -a 32 # read perf counters from lid 32,
all ports
perfquery -r 32 1 # read performance counters and
reset
perfquery -x -r 32 1 # read extended performance counters
and reset
perfquery -R 0x20 1 # reset performance counters of port
1 only
perfquery -x -R 0x20 1 # reset extended performance coun-
ters of port 1 only
OpenIB Last change: Jun 16, 2010 3
OpenIB Diagnostics PERFQUERY(1m)
perfquery -R -a 32 # reset performance counters of all
ports
perfquery -R 32 2 0x0fff # reset only error counters of port
2
perfquery -R 32 2 0xf000 # reset only non-error counters of
port 2
AUTHOR
Hal Rosenstock
<hal.rosenstock@gmail.com>
ATTRIBUTES
See attributes(5) for descriptions of the following
attributes:
+---------------+----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+----------------------+
|Availability | network/open-fabrics |
+---------------+----------------------+
|Stability | Volatile |
+---------------+----------------------+
NOTES
This software was built from source available at
https://java.net/projects/solaris-userland. The original
community source was downloaded from ['http://www.openfab-
rics.org/downloads/ibutils/ibutils-1.5.7.tar.gz',
'http://www.openfabrics.org/downloads/libibverbs/libib-
verbs-1.1.4-1.22.g7257cd3.tar.gz', 'http://www.openfab-
rics.org/down-
loads/libmlx4/libmlx4-1.0.1-1.18.gb810a27.tar.gz',
'http://www.openfabrics.org/downloads/libsdp/lib-
sdp-1.1.108-0.15.gd7fdb72.tar.gz', 'http://www.openfab-
rics.org/downloads/management/infiniband-
diags-1.5.8.tar.gz', 'http://www.openfabrics.org/down-
loads/management/libibmad-1.3.7.tar.gz', 'http://www.open-
fabrics.org/downloads/management/libibumad-1.3.7.tar.gz',
'http://www.openfabrics.org/downloads/manage-
ment/opensm-3.3.9.tar.gz', 'http://www.openfabrics.org/down-
loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz',
'http://www.openfabrics.org/down-
loads/qperf/qperf-0.4.6-0.1.gb81434e.tar.gz',
'http://www.openfabrics.org/downloads/rdmacm/librd-
macm-1.0.14.1.tar.gz', 'http://www.openfabrics.org/down-
loads/rds-tools/rds-tools-2.0.4.tar.gz']
Further information about this software can be found on the
OpenIB Last change: Jun 16, 2010 4
OpenIB Diagnostics PERFQUERY(1m)
open source community website at http://www.openfab-
rics.org/.
OpenIB Last change: Jun 16, 2010 5