summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man8/rdma-statistic.8
blob: 7dd2b02c3e92815a0d46fb308119c8061e6e4734 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
.TH RDMA\-STATISTIC 8 "27 June 2019" "iproute2" "Linux"
.SH NAME
rdma-statistic \- RDMA statistic counter configuration
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B rdma
.RI "[ " OPTIONS " ]"
.B statistic
.RI  "{ " COMMAND " | "
.BR help " }"
.sp

.ti -8
.B rdma statistic
.RI "{ " OBJECT " }"
.B show

.ti -8
.B rdma statistic
.RI "[ " OBJECT " ]"
.B show link
.RI "[ " DEV/PORT_INDX " ]"
.RI "[ " FILTER_NAME " " FILTER_VALUE " ]"

.ti -8
.B rdma statistic
.IR OBJECT
.B mode

.ti -8
.B rdma statistic
.IR OBJECT
.B set
.IR COUNTER_SCOPE
.RI "[ " DEV/PORT_INDEX " ]"
.B auto
.RI "{ " CRITERIA " | "
.BR off " }"

.ti -8
.B rdma statistic
.IR OBJECT
.B bind
.IR COUNTER_SCOPE
.RI "[ " DEV/PORT_INDEX " ]"
.RI "[ " OBJECT-ID " ]"
.RI "[ " COUNTER-ID " ]"

.ti -8
.B rdma statistic
.IR OBJECT
.B unbind
.IR COUNTER_SCOPE
.RI "[ " DEV/PORT_INDEX " ]"
.RI "[ " COUNTER-ID " ]"
.RI "[ " OBJECT-ID " ]"

.ti -8
.B rdma statistic
.B mode
.B "[" supported "]"
.B link
.RI "[ " DEV/PORT_INDEX " ]"

.ti -8
.B rdma statistic
.B set
.B link
.RI "[ " DEV/PORT_INDEX " ]"
.B optional-counters
.RI "[ " OPTIONAL-COUNTERS " ]"

.ti -8
.B rdma statistic
.B unset
.B link
.RI "[ " DEV/PORT_INDEX " ]"
.B optional-counters

.ti -8
.IR COUNTER_SCOPE " := "
.RB "{ " link " | " dev " }"

.ti -8
.IR OBJECT " := "
.RB "{ " qp " | " mr " }"

.ti -8
.IR CRITERIA " := "
.RB "{ " type " | " pid " }"

.ti -8
.IR FILTER_NAME " := "
.RB "{ " cntn " | " lqpn " | " pid " | " qp-type " }"

.SH "DESCRIPTION"
.SS rdma statistic [object] show - Queries the specified RDMA device for RDMA and driver-specific statistics. Show the default hw counters if object is not specified

.PP
.I "DEV"
- specifies counters on this RDMA device to show.

.I "PORT_INDEX"
- specifies counters on this RDMA port to show.

.I "FILTER_NAME
- specifies a filter to show only the results matching it.

.SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
In auto mode all objects belong to one category are bind automatically to a single counter set. The "off" is global for all auto modes together. Not applicable for MR's.

.SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter
When bound the statistics of this object are available in this counter. Not applicable for MR's.

.SS rdma statistic <object> unbind - manually unbind an object (e.g., a qp) from the counter previously bound
When unbound the statistics of this object are no longer available in this counter; And if object id is not specified then all objects on this counter will be unbound. Not applicable for MR's.

.I "COUNTER-ID"
- specifies the id of the counter to be bound.
If this argument is omitted then a new counter will be allocated.

.SS rdma statistic mode - Display the enabled optional counters for each link.

.SS rdma statistic mode supported - Display the supported optional counters for each link.

.SS rdma statistic set - Enable a set of optional counters for a specific device/port.

.I "OPTIONAL-COUNTERS"
- specifies the name of the optional counters to enable. Optional counters that are not specified will be disabled. Note that optional counters are driver-specific.

.SS rdma statistic unset - Disable all optional counters for a specific device/port.

.SH "EXAMPLES"
.PP
rdma statistic show
.RS 4
Shows the state of the default counter of all RDMA devices on the system.
.RE
.PP
rdma statistic show link mlx5_2/1
.RS 4
Shows the state of the default counter of specified RDMA port
.RE
.PP
rdma statistic qp show
.RS 4
Shows the state of all qp counters of all RDMA devices on the system.
.RE
.PP
rdma statistic qp show link mlx5_2/1
.RS 4
Shows the state of all qp counters of specified RDMA port.
.RE
.PP
rdma statistic qp show link mlx5_2 pid 30489
.RS 4
Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
.RE
.PP
rdma statistic qp show link mlx5_2 qp-type UD
.RS 4
Shows the state of all qp counters of specified RDMA port and with QP type UD
.RE
.PP
rdma statistic qp mode
.RS 4
List current counter mode on all devices
.RE
.PP
rdma statistic qp mode link mlx5_2/1
.RS 4
List current counter mode of device mlx5_2 port 1
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto type on
.RS 4
On device mlx5_2 port 1, for each new user QP bind it with a counter automatically. Per counter for QPs with same qp type.
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto pid on
.RS 4
On device mlx5_2 port 1, for each new user QP bind it with a counter automatically. Per counter for QPs with same pid.
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto pid,type on
.RS 4
On device mlx5_2 port 1, for each new user QP bind it with a counter automatically. Per counter for QPs with same pid and same type.
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto off
.RS 4
Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
.RE
.PP
rdma statistic qp bind link mlx5_2/1 lqpn 178
.RS 4
On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
.RE
.PP
rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
.RS 4
On device mlx5_2 port 1, bind the specified qp on the specified counter
.RE
.PP
rdma statistic qp unbind link mlx5_2/1 cntn 4
.RS 4
On device mlx5_2 port 1, unbind all QPs on the specified counter. After that this counter will be released automatically by the kernel.
.RE
.PP
rdma statistic show mr
.RS 4
List all currently allocated MR's and their counters.
.RE
.PP
rdma statistic show mr mrn 6
.RS 4
Dump a specific MR statistics with mrn 6. Dumps nothing if does not exists.
.RE
.PP
rdma statistic mode link mlx5_2/1
.RS 4
Display the optional counters that was enabled on mlx5_2/1.
.RE
.PP
rdma statistic mode supported link mlx5_2/1
.RS 4
Display the optional counters that mlx5_2/1 supports.
.RE
.PP
rdma statistic set link mlx5_2/1 optional-counters cc_rx_ce_pkts,cc_rx_cnp_pkts
.RS 4
Enable the cc_rx_ce_pkts,cc_rx_cnp_pkts counters on device mlx5_2 port 1.
.RE
.PP
rdma statistic unset link mlx5_2/1 optional-counters
.RS 4
Disable all the optional counters on device mlx5_2 port 1.
.RE

.SH SEE ALSO
.BR rdma (8),
.BR rdma-dev (8),
.BR rdma-link (8),
.BR rdma-resource (8),
.br

.SH AUTHORS
Mark Zhang <markz@mellanox.com>
.br
Erez Alfasi <ereza@mellanox.com>
.br
Neta Ostrovsky <netao@nvidia.com>