matthias
/
iproute2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

rdma: Document MR statistics 

Add document of accessing the MR counters into
the rdma-statistic man pages.

Signed-off-by: Erez Alfasi <ereza@mellanox.com>
Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
This commit is contained in:
Erez Alfasi 2019-10-23 13:38:54 +03:00 committed by David Ahern
parent 33552ade17
commit 5c78ffa0e5
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
man/man8/rdma-statistic.8
View File

@ -1,4 +1,4 @@
.TH RDMA\-STATISTIC 8 "17 Mar 2019" "iproute2" "Linux" .TH RDMA\-STATISTIC 8 "27 June 2019" "iproute2" "Linux"
.SH NAME .SH NAME
rdma-statistic \- RDMA statistic counter configuration rdma-statistic \- RDMA statistic counter configuration
.SH SYNOPSIS .SH SYNOPSIS
@ -15,7 +15,7 @@ rdma-statistic \- RDMA statistic counter configuration
.ti -8 .ti -8
.B rdma statistic .B rdma statistic
.RI "[ " OBJECT " ]" .RI "{ " OBJECT " }"
.B show .B show
.ti -8 .ti -8
@ -63,7 +63,7 @@ rdma-statistic \- RDMA statistic counter configuration
.ti -8 .ti -8
.IR OBJECT " := " .IR OBJECT " := "
.RB "{ " qp " }" .RB "{ " qp " | " mr " }"
.ti -8 .ti -8
.IR CRITERIA " := " .IR CRITERIA " := "
@ -80,13 +80,13 @@ rdma-statistic \- RDMA statistic counter configuration
- specifies counters on this RDMA port to show. - specifies counters on this RDMA port to show.
.SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port .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. In auto mode all objects belong to one category are bind automatically to a single counter set. Not applicable for MR's.
.SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter .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. 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 .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. 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" .I "COUNTER-ID"
- specifies the id of the counter to be bound. - specifies the id of the counter to be bound.
@ -152,9 +152,16 @@ On device mlx5_2 port 1, bind the specified qp on the specified counter
rdma statistic qp unbind link mlx5_2/1 cntn 4 rdma statistic qp unbind link mlx5_2/1 cntn 4
.RS 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. 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 .RE
.PP .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.
.SH SEE ALSO .SH SEE ALSO
.BR rdma (8), .BR rdma (8),
@ -163,5 +170,7 @@ On device mlx5_2 port 1, unbind all QPs on the specified counter. After that thi
.BR rdma-resource (8), .BR rdma-resource (8),
.br .br
.SH AUTHOR .SH AUTHORS
Mark Zhang <markz@mellanox.com> Mark Zhang <markz@mellanox.com>
.br
Erez Alfasi <ereza@mellanox.com>