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

NAME

6       perfquery - query InfiniBand port counters on a single port
7

SYNOPSIS

9       perfquery [options] [<lid|guid> [[port(s)] [reset_mask]]]
10

DESCRIPTION

12       perfquery  uses  PerfMgt GMPs to obtain the PortCounters (basic perfor‐
13       mance and error counters), PortExtendedCounters, PortXmitDataSL, PortR‐
14       cvDataSL,  PortRcvErrorDetails,  PortXmitDiscardDetails,  PortExtended‐
15       SpeedsCounters, or PortSamplesControl from the  PMA  at  the  node/port
16       specified.  Optionally shows aggregated counters for all ports of node.
17       Finally it can, reset after read, or just reset the counters.
18
19       Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortR‐
20       cvDataSL,  components that represent Data (e.g. PortXmitData and PortR‐
21       cvData) indicate octets divided by 4 rather than just octets.
22
23       Note: Inputting a port of 255 indicates an operation  be  performed  on
24       all ports.
25
26       Note:  For  PortCounters,  ExtendedCounters, and resets, multiple ports
27       can be specified by either a comma separated list or a port range.  See
28       examples below.
29

OPTIONS

31       -x, --extended
32              show  extended  port counters rather than (basic) port counters.
33              Note that extended port counters attribute is optional.
34
35       -X, --xmtsl
36              show transmit data SL counter. This is an optional  counter  for
37              QoS.
38
39       -S, --rcvsl
40              show  receive  data  SL counter. This is an optional counter for
41              QoS.
42
43       -D, --xmtdisc
44              show transmit discard details. This is an optional counter.
45
46       -E, --rcverr
47              show receive error details. This is an optional counter.
48
49       -D, --xmtdisc
50              show transmit discard details. This is an optional counter.
51
52       -T, --extended_speeds
53              show extended speeds port counters. This is an optional counter.
54
55       --oprcvcounters
56              show Rcv Counters per Op code. This is an optional counter.
57
58       --flowctlcounters
59              show flow control counters. This is an optional counter.
60
61       --vloppackets
62              show packets received per Op code per VL. This  is  an  optional
63              counter.
64
65       --vlopdata
66              show  data  received  per  Op  code  per VL. This is an optional
67              counter.
68
69       --vlxmitflowctlerrors
70              show flow control update errors per  VL.  This  is  an  optional
71              counter.
72
73       --vlxmitcounters
74              show  ticks  waiting  to  transmit  counters  per VL. This is an
75              optional counter.
76
77       --swportvlcong
78              show sw port VL congestion. This is an optional counter.
79
80       --rcvcc
81              show Rcv  congestion  control  counters.  This  is  an  optional
82              counter.
83
84       --slrcvfecn
85              show SL Rcv FECN counters. This is an optional counter.
86
87       --slrcvbecn
88              show SL Rcv BECN counters. This is an optional counter.
89
90       --xmitcc
91              show  Xmit  congestion  control  counters.  This  is an optional
92              counter.
93
94       --vlxmittimecc
95              show VL Xmit  Time  congestion  control  counters.  This  is  an
96              optional counter.
97
98       -c, --smplctl
99              show port samples control.
100
101       -a, --all_ports
102              show  aggregated  counters for all ports of the destination lid,
103              reset all counters for all ports, or if multiple ports are spec‐
104              ified,  aggregate  the  counters of the specified ports.  If the
105              destination lid does not support  the  AllPortSelect  flag,  all
106              ports  will  be iterated through to emulate AllPortSelect behav‐
107              ior.
108
109       -l, --loop_ports
110              If all ports are selected by the user  (either  through  the  -a
111              option  or  port  255)  or  multiple ports are specified iterate
112              through each port rather than doing than aggregate operation.
113
114       -r, --reset_after_read
115              reset counters after read
116
117       -R, --Reset_only
118              only reset counters
119
120   Addressing Flags
121       -G, --Guid     The address specified is a Port GUID
122
123       -L, --Lid   The address specified is a LID
124
125       -s, --sm_port <smlid>     use 'smlid' as the target lid for SA queries.
126
127   Port Selection flags
128       -C, --Ca <ca_name>    use the specified ca_name.
129
130       -P, --Port <ca_port>    use the specified ca_port.
131
132   Local port Selection
133       Multiple port/Multiple CA support: when no IB device or port is  speci‐
134       fied  (see  the  "local  umad parameters" below), the libibumad library
135       selects the port to use by the following criteria:
136
137          1. the first port that is ACTIVE.
138
139          2. if not found, the first port that is UP (physical link up).
140
141          If a port  and/or  CA  name  is  specified,  the  libibumad  library
142          attempts  to  fulfill  the  user request, and will fail if it is not
143          possible.
144
145          For example:
146
147              ibaddr                 # use the first port (criteria #1 above)
148              ibaddr -C mthca1       # pick the best port from "mthca1" only.
149              ibaddr -P 2            # use the second (active/up) port from the first available IB device.
150              ibaddr -C mthca0 -P 2  # use the specified port only.
151
152   Debugging flags
153       -d     raise the IB debugging level.  May be used several  times  (-ddd
154              or -d -d -d).
155
156       -e     show send and receive errors (timeouts and others)
157
158       -h, --help      show the usage message
159
160       -v, --verbose
161              increase  the  application verbosity level.  May be used several
162              times (-vv or -v -v -v)
163
164       -V, --version     show the version info.
165
166   Configuration flags
167       -t,  --timeout  <timeout_ms>  override  the  default  timeout  for  the
168       solicited mads.
169
170       -y, --m_key <key>
171              use the specified M_key for requests. If non-numeric value (like
172              'x') is specified then a value will be prompted for.
173
174       --config, -z  <config_file> Specify alternate config file.
175          Default: /etc/infiniband-diags/ibdiag.conf
176

FILES

178   CONFIG FILE
179       /etc/infiniband-diags/ibdiag.conf
180
181       A global config file is provided to set some of the common options  for
182       all tools.  See supplied config file for details.
183

EXAMPLES

185          perfquery                # read local port performance counters
186          perfquery 32 1           # read performance counters from lid 32, port 1
187          perfquery -x 32 1        # read extended performance counters from lid 32, port 1
188          perfquery -a 32          # read perf counters from lid 32, all ports
189          perfquery -r 32 1        # read performance counters and reset
190          perfquery -x -r 32 1     # read extended performance counters and reset
191          perfquery -R 0x20 1      # reset performance counters of port 1 only
192          perfquery -x -R 0x20 1   # reset extended performance counters of port 1 only
193          perfquery -R -a 32       # reset performance counters of all ports
194          perfquery -R 32 2 0x0fff # reset only error counters of port 2
195          perfquery -R 32 2 0xf000 # reset only non-error counters of port 2
196          perfquery -a 32 1-10     # read performance counters from lid 32, port 1-10, aggregate output
197          perfquery -l 32 1-10     # read performance counters from lid 32, port 1-10, output each port
198          perfquery -a 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, aggregate output
199          perfquery -l 32 1,4,8    # read performance counters from lid 32, port 1, 4, and 8, output each port
200

AUTHOR

202       Hal Rosenstock
203              < hal.rosenstock@gmail.com >
204
205
206
207
208                                  2017-08-21                      PERFQUERY(8)
Impressum