|
Packit |
db064d |
.\" Man page generated from reStructuredText.
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.TH PERFQUERY 8 "@BUILD_DATE@" "" "Open IB Diagnostics"
|
|
Packit |
db064d |
.SH NAME
|
|
Packit |
db064d |
perfquery \- query InfiniBand port counters on a single port
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.nr rst2man-indent-level 0
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.de1 rstReportMargin
|
|
Packit |
db064d |
\\$1 \\n[an-margin]
|
|
Packit |
db064d |
level \\n[rst2man-indent-level]
|
|
Packit |
db064d |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
Packit |
db064d |
-
|
|
Packit |
db064d |
\\n[rst2man-indent0]
|
|
Packit |
db064d |
\\n[rst2man-indent1]
|
|
Packit |
db064d |
\\n[rst2man-indent2]
|
|
Packit |
db064d |
..
|
|
Packit |
db064d |
.de1 INDENT
|
|
Packit |
db064d |
.\" .rstReportMargin pre:
|
|
Packit |
db064d |
. RS \\$1
|
|
Packit |
db064d |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
Packit |
db064d |
. nr rst2man-indent-level +1
|
|
Packit |
db064d |
.\" .rstReportMargin post:
|
|
Packit |
db064d |
..
|
|
Packit |
db064d |
.de UNINDENT
|
|
Packit |
db064d |
. RE
|
|
Packit |
db064d |
.\" indent \\n[an-margin]
|
|
Packit |
db064d |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
Packit |
db064d |
.nr rst2man-indent-level -1
|
|
Packit |
db064d |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
Packit |
db064d |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
Packit |
db064d |
..
|
|
Packit |
db064d |
.SH SYNOPSIS
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
perfquery [options] [<lid|guid> [[port(s)] [reset_mask]]]
|
|
Packit |
db064d |
.SH DESCRIPTION
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
perfquery uses PerfMgt GMPs to obtain the PortCounters (basic performance and
|
|
Packit |
db064d |
error counters), PortExtendedCounters, PortXmitDataSL, PortRcvDataSL,
|
|
Packit |
db064d |
PortRcvErrorDetails, PortXmitDiscardDetails, PortExtendedSpeedsCounters, or
|
|
Packit |
db064d |
PortSamplesControl from the PMA at the node/port specified. Optionally shows
|
|
Packit |
db064d |
aggregated counters for all ports of node. Finally it can, reset after read,
|
|
Packit |
db064d |
or just reset the counters.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortRcvDataSL,
|
|
Packit |
db064d |
components that represent Data (e.g. PortXmitData and PortRcvData) indicate
|
|
Packit |
db064d |
octets divided by 4 rather than just octets.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
Note: Inputting a port of 255 indicates an operation be performed on all ports.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
Note: For PortCounters, ExtendedCounters, and resets, multiple ports can be
|
|
Packit |
db064d |
specified by either a comma separated list or a port range. See examples below.
|
|
Packit |
db064d |
.SH OPTIONS
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-x, \-\-extended\fP
|
|
Packit |
db064d |
show extended port counters rather than (basic) port counters.
|
|
Packit |
db064d |
Note that extended port counters attribute is optional.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-X, \-\-xmtsl\fP
|
|
Packit |
db064d |
show transmit data SL counter. This is an optional counter for QoS.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-S, \-\-rcvsl\fP
|
|
Packit |
db064d |
show receive data SL counter. This is an optional counter for QoS.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-D, \-\-xmtdisc\fP
|
|
Packit |
db064d |
show transmit discard details. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-E, \-\-rcverr\fP
|
|
Packit |
db064d |
show receive error details. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-D, \-\-xmtdisc\fP
|
|
Packit |
db064d |
show transmit discard details. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-T, \-\-extended_speeds\fP
|
|
Packit |
db064d |
show extended speeds port counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-oprcvcounters\fP
|
|
Packit |
db064d |
show Rcv Counters per Op code. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-flowctlcounters\fP
|
|
Packit |
db064d |
show flow control counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-vloppackets\fP
|
|
Packit |
db064d |
show packets received per Op code per VL. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-vlopdata\fP
|
|
Packit |
db064d |
show data received per Op code per VL. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-vlxmitflowctlerrors\fP
|
|
Packit |
db064d |
show flow control update errors per VL. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-vlxmitcounters\fP
|
|
Packit |
db064d |
show ticks waiting to transmit counters per VL. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-swportvlcong\fP
|
|
Packit |
db064d |
show sw port VL congestion. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-rcvcc\fP
|
|
Packit |
db064d |
show Rcv congestion control counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-slrcvfecn\fP
|
|
Packit |
db064d |
show SL Rcv FECN counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-slrcvbecn\fP
|
|
Packit |
db064d |
show SL Rcv BECN counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-xmitcc\fP
|
|
Packit |
db064d |
show Xmit congestion control counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-\-vlxmittimecc\fP
|
|
Packit |
db064d |
show VL Xmit Time congestion control counters. This is an optional counter.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-c, \-\-smplctl\fP
|
|
Packit |
db064d |
show port samples control.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-a, \-\-all_ports\fP
|
|
Packit |
db064d |
show aggregated counters for all ports of the destination lid, reset
|
|
Packit |
db064d |
all counters for all ports, or if multiple ports are specified, aggregate
|
|
Packit |
db064d |
the counters of the specified ports. If the destination lid does not support
|
|
Packit |
db064d |
the AllPortSelect flag, all ports will be iterated through to emulate
|
|
Packit |
db064d |
AllPortSelect behavior.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-l, \-\-loop_ports\fP
|
|
Packit |
db064d |
If all ports are selected by the user (either through the \fB\-a\fP option
|
|
Packit |
db064d |
or port 255) or multiple ports are specified iterate through each port rather
|
|
Packit |
db064d |
than doing than aggregate operation.
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-r, \-\-reset_after_read\fP
|
|
Packit |
db064d |
reset counters after read
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-R, \-\-Reset_only\fP
|
|
Packit |
db064d |
only reset counters
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.SS Addressing Flags
|
|
Packit |
db064d |
.\" Define the common option -G
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-G, \-\-Guid\fP The address specified is a Port GUID
|
|
Packit |
db064d |
.\" Define the common option -L
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-L, \-\-Lid\fP The address specified is a LID
|
|
Packit |
db064d |
.\" Define the common option -s
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-s, \-\-sm_port <smlid>\fP use \(aqsmlid\(aq as the target lid for SA queries.
|
|
Packit |
db064d |
.SS Port Selection flags
|
|
Packit |
db064d |
.\" Define the common option -C
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-C, \-\-Ca <ca_name>\fP use the specified ca_name.
|
|
Packit |
db064d |
.\" Define the common option -P
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-P, \-\-Port <ca_port>\fP use the specified ca_port.
|
|
Packit |
db064d |
.\" Explanation of local port selection
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.SS Local port Selection
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
Multiple port/Multiple CA support: when no IB device or port is specified
|
|
Packit |
db064d |
(see the "local umad parameters" below), the libibumad library
|
|
Packit |
db064d |
selects the port to use by the following criteria:
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.IP 1. 3
|
|
Packit |
db064d |
the first port that is ACTIVE.
|
|
Packit |
db064d |
.IP 2. 3
|
|
Packit |
db064d |
if not found, the first port that is UP (physical link up).
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
If a port and/or CA name is specified, the libibumad library attempts
|
|
Packit |
db064d |
to fulfill the user request, and will fail if it is not possible.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
For example:
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
.nf
|
|
Packit |
db064d |
.ft C
|
|
Packit |
db064d |
ibaddr # use the first port (criteria #1 above)
|
|
Packit |
db064d |
ibaddr \-C mthca1 # pick the best port from "mthca1" only.
|
|
Packit |
db064d |
ibaddr \-P 2 # use the second (active/up) port from the first available IB device.
|
|
Packit |
db064d |
ibaddr \-C mthca0 \-P 2 # use the specified port only.
|
|
Packit |
db064d |
.ft P
|
|
Packit |
db064d |
.fi
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.SS Debugging flags
|
|
Packit |
db064d |
.\" Define the common option -d
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \-d
|
|
Packit |
db064d |
raise the IB debugging level.
|
|
Packit |
db064d |
May be used several times (\-ddd or \-d \-d \-d).
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Define the common option -e
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \-e
|
|
Packit |
db064d |
show send and receive errors (timeouts and others)
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Define the common option -h
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-h, \-\-help\fP show the usage message
|
|
Packit |
db064d |
.\" Define the common option -v
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-v, \-\-verbose\fP
|
|
Packit |
db064d |
increase the application verbosity level.
|
|
Packit |
db064d |
May be used several times (\-vv or \-v \-v \-v)
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Define the common option -V
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-V, \-\-version\fP show the version info.
|
|
Packit |
db064d |
.SS Configuration flags
|
|
Packit |
db064d |
.\" Define the common option -t
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
|
|
Packit |
db064d |
.\" Define the common option -y
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B \fB\-y, \-\-m_key <key>\fP
|
|
Packit |
db064d |
use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
|
|
Packit |
db064d |
is specified then a value will be prompted for.
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Define the common option -z
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
\fB\-\-config, \-z <config_file>\fP Specify alternate config file.
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
Default: @IBDIAG_CONFIG_PATH@/ibdiag.conf
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.SH FILES
|
|
Packit |
db064d |
.\" Common text for the config file
|
|
Packit |
db064d |
.
|
|
Packit |
db064d |
.SS CONFIG FILE
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
@IBDIAG_CONFIG_PATH@/ibdiag.conf
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
A global config file is provided to set some of the common options for all
|
|
Packit |
db064d |
tools. See supplied config file for details.
|
|
Packit |
db064d |
.SH EXAMPLES
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.INDENT 3.5
|
|
Packit |
db064d |
.sp
|
|
Packit |
db064d |
.nf
|
|
Packit |
db064d |
.ft C
|
|
Packit |
db064d |
perfquery # read local port performance counters
|
|
Packit |
db064d |
perfquery 32 1 # read performance counters from lid 32, port 1
|
|
Packit |
db064d |
perfquery \-x 32 1 # read extended performance counters from lid 32, port 1
|
|
Packit |
db064d |
perfquery \-a 32 # read perf counters from lid 32, all ports
|
|
Packit |
db064d |
perfquery \-r 32 1 # read performance counters and reset
|
|
Packit |
db064d |
perfquery \-x \-r 32 1 # read extended performance counters and reset
|
|
Packit |
db064d |
perfquery \-R 0x20 1 # reset performance counters of port 1 only
|
|
Packit |
db064d |
perfquery \-x \-R 0x20 1 # reset extended performance counters of port 1 only
|
|
Packit |
db064d |
perfquery \-R \-a 32 # reset performance counters of all ports
|
|
Packit |
db064d |
perfquery \-R 32 2 0x0fff # reset only error counters of port 2
|
|
Packit |
db064d |
perfquery \-R 32 2 0xf000 # reset only non\-error counters of port 2
|
|
Packit |
db064d |
perfquery \-a 32 1\-10 # read performance counters from lid 32, port 1\-10, aggregate output
|
|
Packit |
db064d |
perfquery \-l 32 1\-10 # read performance counters from lid 32, port 1\-10, output each port
|
|
Packit |
db064d |
perfquery \-a 32 1,4,8 # read performance counters from lid 32, port 1, 4, and 8, aggregate output
|
|
Packit |
db064d |
perfquery \-l 32 1,4,8 # read performance counters from lid 32, port 1, 4, and 8, output each port
|
|
Packit |
db064d |
.ft P
|
|
Packit |
db064d |
.fi
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.SH AUTHOR
|
|
Packit |
db064d |
.INDENT 0.0
|
|
Packit |
db064d |
.TP
|
|
Packit |
db064d |
.B Hal Rosenstock
|
|
Packit |
db064d |
< \fI\%hal.rosenstock@gmail.com\fP >
|
|
Packit |
db064d |
.UNINDENT
|
|
Packit |
db064d |
.\" Generated by docutils manpage writer.
|
|
Packit |
db064d |
.
|