Debian Codegraph @

upstream/debian-trixie/man8/rdma-statistic.8

raw
1 .TH RDMA\-STATISTIC 8 "27 June 2019" "iproute2" "Linux"
2 .SH NAME
3 rdma-statistic \- RDMA statistic counter configuration
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B rdma
10 .RI "[ " OPTIONS " ]"
11 .B statistic
12 .RI "{ " COMMAND " | "
13 .BR help " }"
14 .sp
15
16 .ti -8
17 .B rdma statistic
18 .RI "{ " OBJECT " }"
19 .B show
20
21 .ti -8
22 .B rdma statistic
23 .RI "[ " OBJECT " ]"
24 .B show link
25 .RI "[ " DEV/PORT_INDX " ]"
26 .RI "[ " FILTER_NAME " " FILTER_VALUE " ]"
27
28 .ti -8
29 .B rdma statistic
30 .IR OBJECT
31 .B mode
32
33 .ti -8
34 .B rdma statistic
35 .IR OBJECT
36 .B set
37 .IR COUNTER_SCOPE
38 .RI "[ " DEV/PORT_INDEX " ]"
39 .B auto
40 .RI "{ " CRITERIA " | "
41 .BR off " }"
42 .B [ optional-counters | on/off ]
43
44 .ti -8
45 .B rdma statistic
46 .IR OBJECT
47 .B bind
48 .IR COUNTER_SCOPE
49 .RI "[ " DEV/PORT_INDEX " ]"
50 .RI "[ " OBJECT-ID " ]"
51 .RI "[ " COUNTER-ID " ]"
52
53 .ti -8
54 .B rdma statistic
55 .IR OBJECT
56 .B unbind
57 .IR COUNTER_SCOPE
58 .RI "[ " DEV/PORT_INDEX " ]"
59 .RI "[ " COUNTER-ID " ]"
60 .RI "[ " OBJECT-ID " ]"
61
62 .ti -8
63 .B rdma statistic
64 .B mode
65 .B "[" supported "]"
66 .B link
67 .RI "[ " DEV/PORT_INDEX " ]"
68
69 .ti -8
70 .B rdma statistic
71 .B set
72 .B link
73 .RI "[ " DEV/PORT_INDEX " ]"
74 .B optional-counters
75 .RI "[ " OPTIONAL-COUNTERS " ]"
76
77 .ti -8
78 .B rdma statistic
79 .B unset
80 .B link
81 .RI "[ " DEV/PORT_INDEX " ]"
82 .B optional-counters
83
84 .ti -8
85 .IR COUNTER_SCOPE " := "
86 .RB "{ " link " | " dev " }"
87
88 .ti -8
89 .IR OBJECT " := "
90 .RB "{ " qp " | " mr " }"
91
92 .ti -8
93 .IR CRITERIA " := "
94 .RB "{ " type " | " pid " }"
95
96 .ti -8
97 .IR FILTER_NAME " := "
98 .RB "{ " cntn " | " lqpn " | " pid " | " qp-type " }"
99
100 .SH "DESCRIPTION"
101 .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
102
103 .PP
104 .I "DEV"
105 - specifies counters on this RDMA device to show.
106
107 .I "PORT_INDEX"
108 - specifies counters on this RDMA port to show.
109
110 .I "FILTER_NAME
111 - specifies a filter to show only the results matching it.
112
113 .SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
114 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.
115
116 .SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter
117 When bound the statistics of this object are available in this counter. Not applicable for MR's.
118
119 .SS rdma statistic <object> unbind - manually unbind an object (e.g., a qp) from the counter previously bound
120 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.
121
122 .I "COUNTER-ID"
123 - specifies the id of the counter to be bound.
124 If this argument is omitted then a new counter will be allocated.
125
126 .SS rdma statistic mode - Display the enabled optional counters for each link.
127
128 .SS rdma statistic mode supported - Display the supported optional counters for each link.
129
130 .SS rdma statistic set - Enable a set of optional counters for a specific device/port.
131
132 .I "OPTIONAL-COUNTERS"
133 - 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.
134
135 .SS rdma statistic unset - Disable all optional counters for a specific device/port.
136
137 .SH "EXAMPLES"
138 .PP
139 rdma statistic show
140 .RS 4
141 Shows the state of the default counter of all RDMA devices on the system.
142 .RE
143 .PP
144 rdma statistic show link mlx5_2/1
145 .RS 4
146 Shows the state of the default counter of specified RDMA port
147 .RE
148 .PP
149 rdma statistic qp show
150 .RS 4
151 Shows the state of all qp counters of all RDMA devices on the system.
152 .RE
153 .PP
154 rdma statistic qp show link mlx5_2/1
155 .RS 4
156 Shows the state of all qp counters of specified RDMA port.
157 .RE
158 .PP
159 rdma statistic qp show link mlx5_2 pid 30489
160 .RS 4
161 Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
162 .RE
163 .PP
164 rdma statistic qp show link mlx5_2 qp-type UD
165 .RS 4
166 Shows the state of all qp counters of specified RDMA port and with QP type UD
167 .RE
168 .PP
169 rdma statistic qp mode
170 .RS 4
171 List current counter mode on all devices
172 .RE
173 .PP
174 rdma statistic qp mode link mlx5_2/1
175 .RS 4
176 List current counter mode of device mlx5_2 port 1
177 .RE
178 .PP
179 rdma statistic qp set link mlx5_2/1 auto type on
180 .RS 4
181 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.
182 .RE
183 .PP
184 rdma statistic qp set link mlx5_2/1 auto type on optional-counters on
185 .RS 4
186 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. Whilst also binding the currently enabled optional-counters.
187 .RE
188 .PP
189 rdma statistic qp set link mlx5_2/1 auto pid on
190 .RS 4
191 On device mlx5_2 port 1, for each new user QP bind it with a counter automatically. Per counter for QPs with same pid.
192 .RE
193 .PP
194 rdma statistic qp set link mlx5_2/1 auto pid,type on
195 .RS 4
196 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.
197 .RE
198 .PP
199 rdma statistic qp set link mlx5_2/1 auto off
200 .RS 4
201 Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
202 .RE
203 .PP
204 rdma statistic qp bind link mlx5_2/1 lqpn 178
205 .RS 4
206 On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
207 .RE
208 .PP
209 rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
210 .RS 4
211 On device mlx5_2 port 1, bind the specified qp on the specified counter
212 .RE
213 .PP
214 rdma statistic qp unbind link mlx5_2/1 cntn 4
215 .RS 4
216 On device mlx5_2 port 1, unbind all QPs on the specified counter. After that this counter will be released automatically by the kernel.
217 .RE
218 .PP
219 rdma statistic show mr
220 .RS 4
221 List all currently allocated MR's and their counters.
222 .RE
223 .PP
224 rdma statistic show mr mrn 6
225 .RS 4
226 Dump a specific MR statistics with mrn 6. Dumps nothing if does not exists.
227 .RE
228 .PP
229 rdma statistic mode link mlx5_2/1
230 .RS 4
231 Display the optional counters that was enabled on mlx5_2/1.
232 .RE
233 .PP
234 rdma statistic mode supported link mlx5_2/1
235 .RS 4
236 Display the optional counters that mlx5_2/1 supports.
237 .RE
238 .PP
239 rdma statistic set link mlx5_2/1 optional-counters cc_rx_ce_pkts,cc_rx_cnp_pkts
240 .RS 4
241 Enable the cc_rx_ce_pkts,cc_rx_cnp_pkts counters on device mlx5_2 port 1.
242 .RE
243 .PP
244 rdma statistic unset link mlx5_2/1 optional-counters
245 .RS 4
246 Disable all the optional counters on device mlx5_2 port 1.
247 .RE
248
249 .SH SEE ALSO
250 .BR rdma (8),
251 .BR rdma-dev (8),
252 .BR rdma-link (8),
253 .BR rdma-resource (8),
254 .br
255
256 .SH AUTHORS
257 Mark Zhang <[email protected]>
258 .br
259 Erez Alfasi <[email protected]>
260 .br
261 Neta Ostrovsky <[email protected]>