contrib/ofed/infiniband-diags/man/perfquery.8

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH PERFQUERY 8 "" "" "Open IB Diagnostics"
   4 .SH NAME
   5 PERFQUERY \-
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .SH QUERY INFINIBAND PORT COUNTERS ON A SINGLE PORT
  34 .SS SYNOPSIS
  35 .sp
  36 perfquery [options] [<lid|guid> [[port(s)] [reset_mask]]]
  37 .SS DESCRIPTION
  38 .sp
  39 perfquery uses PerfMgt GMPs to obtain the PortCounters (basic performance and
  40 error counters), PortExtendedCounters, PortXmitDataSL, PortRcvDataSL,
  41 PortRcvErrorDetails, PortXmitDiscardDetails, PortExtendedSpeedsCounters, or
  42 PortSamplesControl from the PMA at the node/port specified. Optionally shows
  43 aggregated counters for all ports of node.  Finally it can, reset after read,
  44 or just reset the counters.
  45 .sp
  46 Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortRcvDataSL,
  47 components that represent Data (e.g. PortXmitData and PortRcvData) indicate
  48 octets divided by 4 rather than just octets.
  49 .sp
  50 Note: Inputting a port of 255 indicates an operation be performed on all ports.
  51 .sp
  52 Note: For PortCounters, ExtendedCounters, and resets, multiple ports can be
  53 specified by either a comma separated list or a port range.  See examples below.
  54 .SS OPTIONS
  55 .INDENT 0.0
  56 .TP
  57 .B \fB\-x, \-\-extended\fP
  58 show extended port counters rather than (basic) port counters.
  59 Note that extended port counters attribute is optional.
  60 .TP
  61 .B \fB\-X, \-\-xmtsl\fP
  62 show transmit data SL counter. This is an optional counter for QoS.
  63 .TP
  64 .B \fB\-S, \-\-rcvsl\fP
  65 show receive data SL counter. This is an optional counter for QoS.
  66 .TP
  67 .B \fB\-D, \-\-xmtdisc\fP
  68 show transmit discard details. This is an optional counter.
  69 .TP
  70 .B \fB\-E, \-\-rcverr\fP
  71 show receive error details. This is an optional counter.
  72 .TP
  73 .B \fB\-D, \-\-xmtdisc\fP
  74 show transmit discard details. This is an optional counter.
  75 .TP
  76 .B \fB\-T, \-\-extended_speeds\fP
  77 show extended speeds port counters. This is an optional counter.
  78 .TP
  79 .B \fB\-\-oprcvcounters\fP
  80 show Rcv Counters per Op code. This is an optional counter.
  81 .TP
  82 .B \fB\-\-flowctlcounters\fP
  83 show flow control counters. This is an optional counter.
  84 .TP
  85 .B \fB\-\-vloppackets\fP
  86 show packets received per Op code per VL. This is an optional counter.
  87 .TP
  88 .B \fB\-\-vlopdata\fP
  89 show data received per Op code per VL. This is an optional counter.
  90 .TP
  91 .B \fB\-\-vlxmitflowctlerrors\fP
  92 show flow control update errors per VL. This is an optional counter.
  93 .TP
  94 .B \fB\-\-vlxmitcounters\fP
  95 show ticks waiting to transmit counters per VL. This is an optional counter.
  96 .TP
  97 .B \fB\-\-swportvlcong\fP
  98 show sw port VL congestion. This is an optional counter.
  99 .TP
 100 .B \fB\-\-rcvcc\fP
 101 show Rcv congestion control counters. This is an optional counter.
 102 .TP
 103 .B \fB\-\-slrcvfecn\fP
 104 show SL Rcv FECN counters. This is an optional counter.
 105 .TP
 106 .B \fB\-\-slrcvbecn\fP
 107 show SL Rcv BECN counters. This is an optional counter.
 108 .TP
 109 .B \fB\-\-xmitcc\fP
 110 show Xmit congestion control counters. This is an optional counter.
 111 .TP
 112 .B \fB\-\-vlxmittimecc\fP
 113 show VL Xmit Time congestion control counters. This is an optional counter.
 114 .TP
 115 .B \fB\-c, \-\-smplctl\fP
 116 show port samples control.
 117 .TP
 118 .B \fB\-a, \-\-all_ports\fP
 119 show aggregated counters for all ports of the destination lid, reset
 120 all counters for all ports, or if multiple ports are specified, aggregate
 121 the counters of the specified ports.  If the destination lid does not support
 122 the AllPortSelect flag, all ports will be iterated through to emulate
 123 AllPortSelect behavior.
 124 .TP
 125 .B \fB\-l, \-\-loop_ports\fP
 126 If all ports are selected by the user (either through the \fB\-a\fP option
 127 or port 255) or multiple ports are specified iterate through each port rather
 128 than doing than aggregate operation.
 129 .TP
 130 .B \fB\-r, \-\-reset_after_read\fP
 131 reset counters after read
 132 .TP
 133 .B \fB\-R, \-\-Reset_only\fP
 134 only reset counters
 135 .TP
 136 .B \fB\-\-dgid <gid>\fP
 137 destination GID: use when GRH is required in packets (IPv6 format)
 138 .UNINDENT
 139 .SS Addressing Flags
 140 .\" Define the common option -G
 141 .
 142 .sp
 143 \fB\-G, \-\-Guid\fP     The address specified is a Port GUID
 144 .\" Define the common option -L
 145 .
 146 .sp
 147 \fB\-L, \-\-Lid\fP   The address specified is a LID
 148 .\" Define the common option -s
 149 .
 150 .sp
 151 \fB\-s, \-\-sm_port <smlid>\fP     use \(aqsmlid\(aq as the target lid for SA queries.
 152 .SS Port Selection flags
 153 .\" Define the common option -C
 154 .
 155 .sp
 156 \fB\-C, \-\-Ca <ca_name>\fP    use the specified ca_name.
 157 .\" Define the common option -P
 158 .
 159 .sp
 160 \fB\-P, \-\-Port <ca_port>\fP    use the specified ca_port.
 161 .\" Explanation of local port selection
 162 .
 163 .SS Local port Selection
 164 .sp
 165 Multiple port/Multiple CA support: when no IB device or port is specified
 166 (see the "local umad parameters" below), the libibumad library
 167 selects the port to use by the following criteria:
 168 .INDENT 0.0
 169 .INDENT 3.5
 170 .INDENT 0.0
 171 .IP 1. 3
 172 the first port that is ACTIVE.
 173 .IP 2. 3
 174 if not found, the first port that is UP (physical link up).
 175 .UNINDENT
 176 .sp
 177 If a port and/or CA name is specified, the libibumad library attempts
 178 to fulfill the user request, and will fail if it is not possible.
 179 .sp
 180 For example:
 181 .INDENT 0.0
 182 .INDENT 3.5
 183 .sp
 184 .nf
 185 .ft C
 186 ibaddr                 # use the first port (criteria #1 above)
 187 ibaddr \-C mthca1       # pick the best port from "mthca1" only.
 188 ibaddr \-P 2            # use the second (active/up) port from the first available IB device.
 189 ibaddr \-C mthca0 \-P 2  # use the specified port only.
 190 .ft P
 191 .fi
 192 .UNINDENT
 193 .UNINDENT
 194 .UNINDENT
 195 .UNINDENT
 196 .SS Debugging flags
 197 .\" Define the common option -d
 198 .
 199 .INDENT 0.0
 200 .TP
 201 .B \-d
 202 raise the IB debugging level.
 203 May be used several times (\-ddd or \-d \-d \-d).
 204 .UNINDENT
 205 .\" Define the common option -e
 206 .
 207 .INDENT 0.0
 208 .TP
 209 .B \-e
 210 show send and receive errors (timeouts and others)
 211 .UNINDENT
 212 .\" Define the common option -h
 213 .
 214 .sp
 215 \fB\-h, \-\-help\fP      show the usage message
 216 .\" Define the common option -v
 217 .
 218 .INDENT 0.0
 219 .TP
 220 .B \fB\-v, \-\-verbose\fP
 221 increase the application verbosity level.
 222 May be used several times (\-vv or \-v \-v \-v)
 223 .UNINDENT
 224 .\" Define the common option -V
 225 .
 226 .sp
 227 \fB\-V, \-\-version\fP     show the version info.
 228 .SS Configuration flags
 229 .\" Define the common option -t
 230 .
 231 .sp
 232 \fB\-t, \-\-timeout <timeout_ms>\fP override the default timeout for the solicited mads.
 233 .\" Define the common option -y
 234 .
 235 .INDENT 0.0
 236 .TP
 237 .B \fB\-y, \-\-m_key <key>\fP
 238 use the specified M_key for requests. If non\-numeric value (like \(aqx\(aq)
 239 is specified then a value will be prompted for.
 240 .UNINDENT
 241 .\" Define the common option -z
 242 .
 243 .sp
 244 \fB\-\-config, \-z  <config_file>\fP Specify alternate config file.
 245 .INDENT 0.0
 246 .INDENT 3.5
 247 Default: /etc/infiniband-diags/ibdiag.conf
 248 .UNINDENT
 249 .UNINDENT
 250 .SS FILES
 251 .\" Common text for the config file
 252 .
 253 .SS CONFIG FILE
 254 .sp
 255 /etc/infiniband-diags/ibdiag.conf
 256 .sp
 257 A global config file is provided to set some of the common options for all
 258 tools.  See supplied config file for details.
 259 .SS EXAMPLES
 260 .INDENT 0.0
 261 .INDENT 3.5
 262 .sp
 263 .nf
 264 .ft C
 265 perfquery                # read local port performance counters
 266 perfquery 32 1           # read performance counters from lid 32, port 1
 267 perfquery \-x 32 1        # read extended performance counters from lid 32, port 1
 268 perfquery \-a 32          # read perf counters from lid 32, all ports
 269 perfquery \-r 32 1        # read performance counters and reset
 270 perfquery \-x \-r 32 1     # read extended performance counters and reset
 271 perfquery \-R 0x20 1      # reset performance counters of port 1 only
 272 perfquery \-x \-R 0x20 1   # reset extended performance counters of port 1 only
 273 perfquery \-R \-a 32       # reset performance counters of all ports
 274 perfquery \-R 32 2 0x0fff # reset only error counters of port 2
 275 perfquery \-R 32 2 0xf000 # reset only non\-error counters of port 2
 276 perfquery \-a 32 1\-10     # read performance counters from lid 32, port 1\-10, aggregate output
 277 perfquery \-l 32 1\-10     # read performance counters from lid 32, port 1\-10, output each port
 278 perfquery \-a 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, aggregate output
 279 perfquery \-l 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, output each port
 280 .ft P
 281 .fi
 282 .UNINDENT
 283 .UNINDENT
 284 .SS AUTHOR
 285 .INDENT 0.0
 286 .TP
 287 .B Hal Rosenstock
 288 < \fI\%hal.rosenstock@gmail.com\fP >
 289 .UNINDENT
 290 .\" Generated by docutils manpage writer.
 291 .