[mirror_iproute2.git] / man / man8 / rdma-statistic.8

.TH RDMA\-STATISTIC 8 "27 June 2019" "iproute2" "Linux"
.SH NAME
rdma-statistic \- RDMA statistic counter configuration
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B rdma
.RI "[ " OPTIONS " ]"
.B statistic
.RI  "{ " COMMAND " | "
.BR help " }"
.sp

.ti -8
.B rdma statistic
.RI "{ " OBJECT " }"
.B show

.ti -8
.B rdma statistic
.RI "[ " OBJECT " ]"
.B show link
.RI "[ " DEV/PORT_INDX " ]"
.RI "[ " FILTER_NAME " " FILTER_VALUE " ]"

.ti -8
.B rdma statistic
.IR OBJECT
.B mode

.ti -8
.B rdma statistic
.IR OBJECT
.B set
.IR COUNTER_SCOPE
.RI "[ " DEV/PORT_INDEX " ]"
.B auto
.RI "{ " CRITERIA " | "
.BR off " }"

.ti -8
.B rdma statistic
.IR OBJECT
.B bind
.IR COUNTER_SCOPE
.RI "[ " DEV/PORT_INDEX " ]"
.RI "[ " OBJECT-ID " ]"
.RI "[ " COUNTER-ID " ]"

.ti -8
.B rdma statistic
.IR OBJECT
.B unbind
.IR COUNTER_SCOPE
.RI "[ " DEV/PORT_INDEX " ]"
.RI "[ " COUNTER-ID " ]"
.RI "[ " OBJECT-ID " ]"

.ti -8
.IR COUNTER_SCOPE " := "
.RB "{ " link " | " dev " }"

.ti -8
.IR OBJECT " := "
.RB "{ " qp " | " mr " }"

.ti -8
.IR CRITERIA " := "
.RB "{ " type " }"

.ti -8
.IR FILTER_NAME " := "
.RB "{ " cntn " | " lqpn " | " pid " }"

.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

.PP
.I "DEV"
- specifies counters on this RDMA device to show.

.I "PORT_INDEX"
- specifies counters on this RDMA port to show.

.I "FILTER_NAME
- 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
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
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
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"
- specifies the id of the counter to be bound.
If this argument is omitted then a new counter will be allocated.

.SH "EXAMPLES"
.PP
rdma statistic show
.RS 4
Shows the state of the default counter of all RDMA devices on the system.
.RE
.PP
rdma statistic show link mlx5_2/1
.RS 4
Shows the state of the default counter of specified RDMA port
.RE
.PP
rdma statistic qp show
.RS 4
Shows the state of all qp counters of all RDMA devices on the system.
.RE
.PP
rdma statistic qp show link mlx5_2/1
.RS 4
Shows the state of all qp counters of specified RDMA port.
.RE
.PP
rdma statistic qp show link mlx5_2 pid 30489
.RS 4
Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
.RE
.PP
rdma statistic qp mode
.RS 4
List current counter mode on all devices
.RE
.PP
rdma statistic qp mode link mlx5_2/1
.RS 4
List current counter mode of device mlx5_2 port 1
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto type on
.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.
.RE
.PP
rdma statistic qp set link mlx5_2/1 auto off
.RS 4
Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
.RE
.PP
rdma statistic qp bind link mlx5_2/1 lqpn 178
.RS 4
On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
.RE
.PP
rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
.RS 4
On device mlx5_2 port 1, bind the specified qp on the specified counter
.RE
.PP
rdma statistic qp unbind link mlx5_2/1 cntn 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.
.RE
.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.
.RE

.SH SEE ALSO
.BR rdma (8),
.BR rdma-dev (8),
.BR rdma-link (8),
.BR rdma-resource (8),
.br

.SH AUTHORS
Mark Zhang <markz@mellanox.com>
.br
Erez Alfasi <ereza@mellanox.com>
Commit	Line	Data
5c78ffa0	1	.TH RDMA\-STATISTIC 8 "27 June 2019" "iproute2" "Linux"
ca084842 MZ	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
31824e22	12	.RI "{ " COMMAND " \| "
ca084842 MZ	13	.BR help " }"
	14	.sp
	15
	16	.ti -8
	17	.B rdma statistic
5c78ffa0	18	.RI "{ " OBJECT " }"
ca084842 MZ	19	.B show
	20
	21	.ti -8
	22	.B rdma statistic
	23	.RI "[ " OBJECT " ]"
	24	.B show link
	25	.RI "[ " DEV/PORT_INDX " ]"
31824e22	26	.RI "[ " FILTER_NAME " " FILTER_VALUE " ]"
ca084842 MZ	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
31824e22	38	.RI "[ " DEV/PORT_INDEX " ]"
ca084842 MZ	39	.B auto
	40	.RI "{ " CRITERIA " \| "
	41	.BR off " }"
	42
	43	.ti -8
	44	.B rdma statistic
	45	.IR OBJECT
	46	.B bind
	47	.IR COUNTER_SCOPE
31824e22	48	.RI "[ " DEV/PORT_INDEX " ]"
ca084842 MZ	49	.RI "[ " OBJECT-ID " ]"
	50	.RI "[ " COUNTER-ID " ]"
	51
	52	.ti -8
	53	.B rdma statistic
	54	.IR OBJECT
	55	.B unbind
	56	.IR COUNTER_SCOPE
31824e22	57	.RI "[ " DEV/PORT_INDEX " ]"
ca084842 MZ	58	.RI "[ " COUNTER-ID " ]"
	59	.RI "[ " OBJECT-ID " ]"
	60
	61	.ti -8
	62	.IR COUNTER_SCOPE " := "
	63	.RB "{ " link " \| " dev " }"
	64
	65	.ti -8
	66	.IR OBJECT " := "
5c78ffa0	67	.RB "{ " qp " \| " mr " }"
ca084842 MZ	68
	69	.ti -8
	70	.IR CRITERIA " := "
	71	.RB "{ " type " }"
	72
31824e22 AC	73	.ti -8
	74	.IR FILTER_NAME " := "
	75	.RB "{ " cntn " \| " lqpn " \| " pid " }"
	76
ca084842 MZ	77	.SH "DESCRIPTION"
	78	.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
	79
	80	.PP
	81	.I "DEV"
	82	- specifies counters on this RDMA device to show.
	83
	84	.I "PORT_INDEX"
	85	- specifies counters on this RDMA port to show.
	86
31824e22 AC	87	.I "FILTER_NAME
	88	- specifies a filter to show only the results matching it.
	89
ca084842	90	.SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
5c78ffa0	91	In auto mode all objects belong to one category are bind automatically to a single counter set. Not applicable for MR's.
ca084842 MZ	92
ca084842 MZ	93	.SS rdma statistic <object> bind - manually bind an object (e.g., a qp) with a counter
5c78ffa0	94	When bound the statistics of this object are available in this counter. Not applicable for MR's.
ca084842 MZ	95
ca084842 MZ	96	.SS rdma statistic <object> unbind - manually unbind an object (e.g., a qp) from the counter previously bound
5c78ffa0	97	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.
ca084842 MZ	98
	99	.I "COUNTER-ID"
	100	- specifies the id of the counter to be bound.
	101	If this argument is omitted then a new counter will be allocated.
	102
	103	.SH "EXAMPLES"
	104	.PP
	105	rdma statistic show
	106	.RS 4
	107	Shows the state of the default counter of all RDMA devices on the system.
	108	.RE
	109	.PP
	110	rdma statistic show link mlx5_2/1
	111	.RS 4
	112	Shows the state of the default counter of specified RDMA port
	113	.RE
	114	.PP
	115	rdma statistic qp show
	116	.RS 4
	117	Shows the state of all qp counters of all RDMA devices on the system.
	118	.RE
	119	.PP
	120	rdma statistic qp show link mlx5_2/1
	121	.RS 4
	122	Shows the state of all qp counters of specified RDMA port.
	123	.RE
	124	.PP
	125	rdma statistic qp show link mlx5_2 pid 30489
	126	.RS 4
	127	Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
	128	.RE
	129	.PP
	130	rdma statistic qp mode
	131	.RS 4
	132	List current counter mode on all devices
	133	.RE
	134	.PP
	135	rdma statistic qp mode link mlx5_2/1
	136	.RS 4
	137	List current counter mode of device mlx5_2 port 1
	138	.RE
	139	.PP
	140	rdma statistic qp set link mlx5_2/1 auto type on
	141	.RS 4
	142	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.
	143	.RE
	144	.PP
	145	rdma statistic qp set link mlx5_2/1 auto off
	146	.RS 4
	147	Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
	148	.RE
	149	.PP
	150	rdma statistic qp bind link mlx5_2/1 lqpn 178
	151	.RS 4
	152	On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
	153	.RE
	154	.PP
	155	rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
	156	.RS 4
	157	On device mlx5_2 port 1, bind the specified qp on the specified counter
	158	.RE
	159	.PP
	160	rdma statistic qp unbind link mlx5_2/1 cntn 4
	161	.RS 4
162	On device mlx5_2 port 1, unbind all QPs on the specified counter. After that this counter will be released automatically by the kernel.
ca084842 MZ	163	.RE
ca084842 MZ	164	.PP
5c78ffa0 EA	165	rdma statistic show mr
	166	.RS 4
	167	List all currently allocated MR's and their counters.
	168	.RE
	169	.PP
	170	rdma statistic show mr mrn 6
	171	.RS 4
	172	Dump a specific MR statistics with mrn 6. Dumps nothing if does not exists.
9ab56784	173	.RE
ca084842 MZ	174
	175	.SH SEE ALSO
	176	.BR rdma (8),
	177	.BR rdma-dev (8),
	178	.BR rdma-link (8),
	179	.BR rdma-resource (8),
	180	.br
	181
5c78ffa0	182	.SH AUTHORS
ca084842	183	Mark Zhang <markz@mellanox.com>
5c78ffa0 EA	184	.br
5c78ffa0 EA	185	Erez Alfasi <ereza@mellanox.com>