Blame man/man8/rdma-statistic.8

Packit d3f73b
.TH RDMA\-STATISTIC 8 "17 Mar 2019" "iproute2" "Linux"
Packit d3f73b
.SH NAME
Packit d3f73b
rdma-statistic \- RDMA statistic counter configuration
Packit d3f73b
.SH SYNOPSIS
Packit d3f73b
.sp
Packit d3f73b
.ad l
Packit d3f73b
.in +8
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma
Packit d3f73b
.RI "[ " OPTIONS " ]"
Packit d3f73b
.B statistic
Packit Service d2ecfd
.RI  "{ " COMMAND " | "
Packit d3f73b
.BR help " }"
Packit d3f73b
.sp
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma statistic
Packit d3f73b
.RI "[ " OBJECT " ]"
Packit d3f73b
.B show
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma statistic
Packit d3f73b
.RI "[ " OBJECT " ]"
Packit d3f73b
.B show link
Packit d3f73b
.RI "[ " DEV/PORT_INDX " ]"
Packit Service d2ecfd
.RI "[ " FILTER_NAME " " FILTER_VALUE " ]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma statistic
Packit d3f73b
.IR OBJECT
Packit d3f73b
.B mode
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma statistic
Packit d3f73b
.IR OBJECT
Packit d3f73b
.B set
Packit d3f73b
.IR COUNTER_SCOPE
Packit Service d2ecfd
.RI "[ " DEV/PORT_INDEX " ]"
Packit d3f73b
.B auto
Packit d3f73b
.RI "{ " CRITERIA " | "
Packit d3f73b
.BR off " }"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma statistic
Packit d3f73b
.IR OBJECT
Packit d3f73b
.B bind
Packit d3f73b
.IR COUNTER_SCOPE
Packit Service d2ecfd
.RI "[ " DEV/PORT_INDEX " ]"
Packit d3f73b
.RI "[ " OBJECT-ID " ]"
Packit d3f73b
.RI "[ " COUNTER-ID " ]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma statistic
Packit d3f73b
.IR OBJECT
Packit d3f73b
.B unbind
Packit d3f73b
.IR COUNTER_SCOPE
Packit Service d2ecfd
.RI "[ " DEV/PORT_INDEX " ]"
Packit d3f73b
.RI "[ " COUNTER-ID " ]"
Packit d3f73b
.RI "[ " OBJECT-ID " ]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.IR COUNTER_SCOPE " := "
Packit d3f73b
.RB "{ " link " | " dev " }"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.IR OBJECT " := "
Packit d3f73b
.RB "{ " qp " }"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.IR CRITERIA " := "
Packit d3f73b
.RB "{ " type " }"
Packit d3f73b
Packit Service d2ecfd
.ti -8
Packit Service d2ecfd
.IR FILTER_NAME " := "
Packit Service d2ecfd
.RB "{ " cntn " | " lqpn " | " pid " }"
Packit Service d2ecfd
Packit d3f73b
.SH "DESCRIPTION"
Packit d3f73b
.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
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV"
Packit d3f73b
- specifies counters on this RDMA device to show.
Packit d3f73b
Packit d3f73b
.I "PORT_INDEX"
Packit d3f73b
- specifies counters on this RDMA port to show.
Packit d3f73b
Packit Service d2ecfd
.I "FILTER_NAME
Packit Service d2ecfd
- specifies a filter to show only the results matching it.
Packit Service d2ecfd
Packit d3f73b
.SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
Packit d3f73b
In auto mode all objects belong to one category are bind automatically to a single counter set.
Packit d3f73b
Packit d3f73b
.SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter
Packit d3f73b
When bound the statistics of this object are available in this counter.
Packit d3f73b
Packit d3f73b
.SS rdma statistic <object> unbind - manually unbind an object (e.g., a qp) from the counter previously bound
Packit d3f73b
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.
Packit d3f73b
Packit d3f73b
.I "COUNTER-ID"
Packit d3f73b
- specifies the id of the counter to be bound.
Packit d3f73b
If this argument is omitted then a new counter will be allocated.
Packit d3f73b
Packit d3f73b
.SH "EXAMPLES"
Packit d3f73b
.PP
Packit d3f73b
rdma statistic show
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of the default counter of all RDMA devices on the system.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic show link mlx5_2/1
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of the default counter of specified RDMA port
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp show
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of all qp counters of all RDMA devices on the system.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp show link mlx5_2/1
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of all qp counters of specified RDMA port.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp show link mlx5_2 pid 30489
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp mode
Packit d3f73b
.RS 4
Packit d3f73b
List current counter mode on all devices
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp mode link mlx5_2/1
Packit d3f73b
.RS 4
Packit d3f73b
List current counter mode of device mlx5_2 port 1
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp set link mlx5_2/1 auto type on
Packit d3f73b
.RS 4
Packit d3f73b
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.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp set link mlx5_2/1 auto off
Packit d3f73b
.RS 4
Packit d3f73b
Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp bind link mlx5_2/1 lqpn 178
Packit d3f73b
.RS 4
Packit d3f73b
On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
Packit d3f73b
.RS 4
Packit d3f73b
On device mlx5_2 port 1, bind the specified qp on the specified counter
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma statistic qp unbind link mlx5_2/1 cntn 4
Packit d3f73b
.RS 4
Packit d3f73b
On device mlx5_2 port 1, unbind all QPs on the specified counter. After that this counter will be released automatically by the kernel.
Packit d3f73b
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
Packit d3f73b
.SH SEE ALSO
Packit d3f73b
.BR rdma (8),
Packit d3f73b
.BR rdma-dev (8),
Packit d3f73b
.BR rdma-link (8),
Packit d3f73b
.BR rdma-resource (8),
Packit d3f73b
.br
Packit d3f73b
Packit d3f73b
.SH AUTHOR
Packit d3f73b
Mark Zhang <markz@mellanox.com>