rdma: Document the new "pid" criteria for auto mode

Document the new supported criteria of auto mode. Examples:
$ rdma statistic qp set link mlx5_2/1 auto pid on
$ rdma statistic qp set link mlx5_2/1 auto pid,type on

Signed-off-by: Mark Zhang <markz@mellanox.com>
Reviewed-by: Ido Kalir <idok@mellanox.com>
Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
Signed-off-by: David Ahern <dsahern@kernel.org>
This commit is contained in:
Mark Zhang 2020-08-04 11:49:09 +03:00 committed by David Ahern
parent e28133316d
commit e8e8f16ed1

View File

@ -68,11 +68,11 @@ rdma-statistic \- RDMA statistic counter configuration
.ti -8 .ti -8
.IR CRITERIA " := " .IR CRITERIA " := "
.RB "{ " type " }" .RB "{ " type " | " pid " }"
.ti -8 .ti -8
.IR FILTER_NAME " := " .IR FILTER_NAME " := "
.RB "{ " cntn " | " lqpn " | " pid " }" .RB "{ " cntn " | " lqpn " | " pid " | " qp-type " }"
.SH "DESCRIPTION" .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 .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
@ -88,7 +88,7 @@ rdma-statistic \- RDMA statistic counter configuration
- specifies a filter to show only the results matching it. - 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 .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. Not applicable for MR's. 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 .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. When bound the statistics of this object are available in this counter. Not applicable for MR's.
@ -127,6 +127,11 @@ rdma statistic qp show link mlx5_2 pid 30489
Shows the state of all qp counters of specified RDMA port and belonging to pid 30489 Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
.RE .RE
.PP .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 rdma statistic qp mode
.RS 4 .RS 4
List current counter mode on all devices List current counter mode on all devices
@ -139,7 +144,17 @@ List current counter mode of device mlx5_2 port 1
.PP .PP
rdma statistic qp set link mlx5_2/1 auto type on rdma statistic qp set link mlx5_2/1 auto type on
.RS 4 .RS 4
On device mlx5_2 port 1, for each new QP bind it with a counter automatically. Per counter for QPs with same qp type in each process. Currently only "type" is supported. 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 .RE
.PP .PP
rdma statistic qp set link mlx5_2/1 auto off rdma statistic qp set link mlx5_2/1 auto off