Debian Codegraph @

upstream/debian-unstable/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 - display RDMA statistics
102
103 Queries the specified RDMA device for RDMA and driver-specific statistics. Shows the default hw counters if object is not specified.
104
105 .PP
106 .I "DEV"
107 - specifies counters on this RDMA device to show.
108
109 .I "PORT_INDEX"
110 - specifies counters on this RDMA port to show.
111
112 .I "FILTER_NAME
113 - specifies a filter to show only the results matching it.
114
115 .SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
116 In auto mode all objects belong to one category are bound automatically to a single counter set. The "off" is global for all auto modes together. Not applicable for MR's.
117
118 .SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter
119 When bound the statistics of this object are available in this counter. Not applicable for MR's.
120
121 .SS rdma statistic <object> unbind - manually unbind an object (e.g., a qp) from the counter previously bound
122 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.
123
124 .I "COUNTER-ID"
125 - specifies the id of the counter to be bound.
126 If this argument is omitted then a new counter will be allocated.
127
128 .SS rdma statistic mode - Display the enabled optional counters for each link.
129
130 .SS rdma statistic mode supported - Display the supported optional counters for each link.
131
132 .SS rdma statistic set - Enable a set of optional counters for a specific device/port.
133
134 .I "OPTIONAL-COUNTERS"
135 - 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.
136
137 .SS rdma statistic unset - Disable all optional counters for a specific device/port.
138
139 .SH "EXAMPLES"
140 .PP
141 rdma statistic show
142 .RS 4
143 Shows the state of the default counter of all RDMA devices on the system.
144 .RE
145 .PP
146 rdma statistic show link mlx5_2/1
147 .RS 4
148 Shows the state of the default counter of specified RDMA port.
149 .RE
150 .PP
151 rdma statistic qp show
152 .RS 4
153 Shows the state of all qp counters of all RDMA devices on the system.
154 .RE
155 .PP
156 rdma statistic qp show link mlx5_2/1
157 .RS 4
158 Shows the state of all qp counters of specified RDMA port.
159 .RE
160 .PP
161 rdma statistic qp show link mlx5_2 pid 30489
162 .RS 4
163 Shows the state of all qp counters of specified RDMA port and belonging to pid 30489.
164 .RE
165 .PP
166 rdma statistic qp show link mlx5_2 qp-type UD
167 .RS 4
168 Shows the state of all qp counters of specified RDMA port and with QP type UD.
169 .RE
170 .PP
171 rdma statistic qp mode
172 .RS 4
173 List current counter mode on all devices.
174 .RE
175 .PP
176 rdma statistic qp mode link mlx5_2/1
177 .RS 4
178 List current counter mode of device mlx5_2 port 1.
179 .RE
180 .PP
181 rdma statistic qp set link mlx5_2/1 auto type on
182 .RS 4
183 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.
184 .RE
185 .PP
186 rdma statistic qp set link mlx5_2/1 auto type on optional-counters on
187 .RS 4
188 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.
189 .RE
190 .PP
191 rdma statistic qp set link mlx5_2/1 auto pid on
192 .RS 4
193 On device mlx5_2 port 1, for each new user QP bind it with a counter automatically. Per counter for QPs with same pid.
194 .RE
195 .PP
196 rdma statistic qp set link mlx5_2/1 auto pid,type on
197 .RS 4
198 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.
199 .RE
200 .PP
201 rdma statistic qp set link mlx5_2/1 auto off
202 .RS 4
203 Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
204 .RE
205 .PP
206 rdma statistic qp bind link mlx5_2/1 lqpn 178
207 .RS 4
208 On device mlx5_2 port 1, allocate a counter and bind the specified qp on it.
209 .RE
210 .PP
211 rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
212 .RS 4
213 On device mlx5_2 port 1, bind the specified qp on the specified counter.
214 .RE
215 .PP
216 rdma statistic qp unbind link mlx5_2/1 cntn 4
217 .RS 4
218 On device mlx5_2 port 1, unbind all QPs on the specified counter. After that this counter will be released automatically by the kernel.
219 .RE
220 .PP
221 rdma statistic show mr
222 .RS 4
223 List all currently allocated MR's and their counters.
224 .RE
225 .PP
226 rdma statistic show mr mrn 6
227 .RS 4
228 Dump a specific MR statistics with mrn 6. Dumps nothing if it does not exist.
229 .RE
230 .PP
231 rdma statistic mode link mlx5_2/1
232 .RS 4
233 Display the optional counters that were enabled on mlx5_2/1.
234 .RE
235 .PP
236 rdma statistic mode supported link mlx5_2/1
237 .RS 4
238 Display the optional counters that mlx5_2/1 supports.
239 .RE
240 .PP
241 rdma statistic set link mlx5_2/1 optional-counters cc_rx_ce_pkts,cc_rx_cnp_pkts
242 .RS 4
243 Enable the cc_rx_ce_pkts,cc_rx_cnp_pkts counters on device mlx5_2 port 1.
244 .RE
245 .PP
246 rdma statistic unset link mlx5_2/1 optional-counters
247 .RS 4
248 Disable all the optional counters on device mlx5_2 port 1.
249 .RE
250
251 .SH SEE ALSO
252 .BR rdma (8),
253 .BR rdma-dev (8),
254 .BR rdma-link (8),
255 .BR rdma-resource (8),
256 .br
257
258 .SH AUTHORS
259 Mark Zhang <[email protected]>
260 .br
261 Erez Alfasi <[email protected]>
262 .br
263 Neta Ostrovsky <[email protected]>