1PERFQUERY(8)                  Open IB Diagnostics                 PERFQUERY(8)
2
3
4

NAME

6       PERFQUERY -
7

QUERY INFINIBAND PORT COUNTERS ON A SINGLE PORT

9   SYNOPSIS
10       perfquery [options] [<lid|guid> [[port(s)] [reset_mask]]]
11
12   DESCRIPTION
13       perfquery  uses  PerfMgt GMPs to obtain the PortCounters (basic perfor‐
14       mance and error counters), PortExtendedCounters, PortXmitDataSL, PortR‐
15       cvDataSL,  PortRcvErrorDetails,  PortXmitDiscardDetails,  PortExtended‐
16       SpeedsCounters, or PortSamplesControl from the  PMA  at  the  node/port
17       specified.  Optionally shows aggregated counters for all ports of node.
18       Finally it can, reset after read, or just reset the counters.
19
20       Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortR‐
21       cvDataSL,  components that represent Data (e.g. PortXmitData and PortR‐
22       cvData) indicate octets divided by 4 rather than just octets.
23
24       Note: Inputting a port of 255 indicates an operation  be  performed  on
25       all ports.
26
27       Note:  For  PortCounters,  ExtendedCounters, and resets, multiple ports
28       can be specified by either a comma separated list or a port range.  See
29       examples below.
30
31   OPTIONS
32       -x, --extended
33              show  extended  port counters rather than (basic) port counters.
34              Note that extended port counters attribute is optional.
35
36       -X, --xmtsl
37              show transmit data SL counter. This is an optional  counter  for
38              QoS.
39
40       -S, --rcvsl
41              show  receive  data  SL counter. This is an optional counter for
42              QoS.
43
44       -D, --xmtdisc
45              show transmit discard details. This is an optional counter.
46
47       -E, --rcverr
48              show receive error details. This is an optional counter.
49
50       -D, --xmtdisc
51              show transmit discard details. This is an optional counter.
52
53       -T, --extended_speeds
54              show extended speeds port counters. This is an optional counter.
55
56       --oprcvcounters
57              show Rcv Counters per Op code. This is an optional counter.
58
59       --flowctlcounters
60              show flow control counters. This is an optional counter.
61
62       --vloppackets
63              show packets received per Op code per VL. This  is  an  optional
64              counter.
65
66       --vlopdata
67              show  data  received  per  Op  code  per VL. This is an optional
68              counter.
69
70       --vlxmitflowctlerrors
71              show flow control update errors per  VL.  This  is  an  optional
72              counter.
73
74       --vlxmitcounters
75              show  ticks  waiting  to  transmit  counters  per VL. This is an
76              optional counter.
77
78       --swportvlcong
79              show sw port VL congestion. This is an optional counter.
80
81       --rcvcc
82              show Rcv  congestion  control  counters.  This  is  an  optional
83              counter.
84
85       --slrcvfecn
86              show SL Rcv FECN counters. This is an optional counter.
87
88       --slrcvbecn
89              show SL Rcv BECN counters. This is an optional counter.
90
91       --xmitcc
92              show  Xmit  congestion  control  counters.  This  is an optional
93              counter.
94
95       --vlxmittimecc
96              show VL Xmit  Time  congestion  control  counters.  This  is  an
97              optional counter.
98
99       -c, --smplctl
100              show port samples control.
101
102       -a, --all_ports
103              show  aggregated  counters for all ports of the destination lid,
104              reset all counters for all ports, or if multiple ports are spec‐
105              ified,  aggregate  the  counters of the specified ports.  If the
106              destination lid does not support  the  AllPortSelect  flag,  all
107              ports  will  be iterated through to emulate AllPortSelect behav‐
108              ior.
109
110       -l, --loop_ports
111              If all ports are selected by the user  (either  through  the  -a
112              option  or  port  255)  or  multiple ports are specified iterate
113              through each port rather than doing than aggregate operation.
114
115       -r, --reset_after_read
116              reset counters after read
117
118       -R, --Reset_only
119              only reset counters
120
121   Addressing Flags
122       -G, --Guid     The address specified is a Port GUID
123
124       -L, --Lid   The address specified is a LID
125
126       -s, --sm_port <smlid>     use 'smlid' as the target lid for SA queries.
127
128   Port Selection flags
129       -C, --Ca <ca_name>    use the specified ca_name.
130
131       -P, --Port <ca_port>    use the specified ca_port.
132
133   Local port Selection
134       Multiple port/Multiple CA support: when no IB device or port is  speci‐
135       fied  (see  the  "local  umad parameters" below), the libibumad library
136       selects the port to use by the following criteria:
137
138          1. the first port that is ACTIVE.
139
140          2. if not found, the first port that is UP (physical link up).
141
142          If a port  and/or  CA  name  is  specified,  the  libibumad  library
143          attempts  to  fulfill  the  user request, and will fail if it is not
144          possible.
145
146          For example:
147
148              ibaddr                 # use the first port (criteria #1 above)
149              ibaddr -C mthca1       # pick the best port from "mthca1" only.
150              ibaddr -P 2            # use the second (active/up) port from the first available IB device.
151              ibaddr -C mthca0 -P 2  # use the specified port only.
152
153   Debugging flags
154       -d     raise the IB debugging level.  May be used several  times  (-ddd
155              or -d -d -d).
156
157       -e     show send and receive errors (timeouts and others)
158
159       -h, --help      show the usage message
160
161       -v, --verbose
162              increase  the  application verbosity level.  May be used several
163              times (-vv or -v -v -v)
164
165       -V, --version     show the version info.
166
167   Configuration flags
168       -t,  --timeout  <timeout_ms>  override  the  default  timeout  for  the
169       solicited mads.
170
171       -y, --m_key <key>
172              use the specified M_key for requests. If non-numeric value (like
173              'x') is specified then a value will be prompted for.
174
175       --config, -z  <config_file> Specify alternate config file.
176          Default: /etc/infiniband-diags/ibdiag.conf
177
178   FILES
179   CONFIG FILE
180       /etc/infiniband-diags/ibdiag.conf
181
182       A global config file is provided to set some of the common options  for
183       all tools.  See supplied config file for details.
184
185   EXAMPLES
186          perfquery                # read local port performance counters
187          perfquery 32 1           # read performance counters from lid 32, port 1
188          perfquery -x 32 1        # read extended performance counters from lid 32, port 1
189          perfquery -a 32          # read perf counters from lid 32, all ports
190          perfquery -r 32 1        # read performance counters and reset
191          perfquery -x -r 32 1     # read extended performance counters and reset
192          perfquery -R 0x20 1      # reset performance counters of port 1 only
193          perfquery -x -R 0x20 1   # reset extended performance counters of port 1 only
194          perfquery -R -a 32       # reset performance counters of all ports
195          perfquery -R 32 2 0x0fff # reset only error counters of port 2
196          perfquery -R 32 2 0xf000 # reset only non-error counters of port 2
197          perfquery -a 32 1-10     # read performance counters from lid 32, port 1-10, aggregate output
198          perfquery -l 32 1-10     # read performance counters from lid 32, port 1-10, output each port
199          perfquery -a 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, aggregate output
200          perfquery -l 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, output each port
201
202   AUTHOR
203       Hal Rosenstock
204              < hal.rosenstock@gmail.com >
205
206
207
208
209                                                                  PERFQUERY(8)
Impressum