[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 " ]"

.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 " }"

.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.

.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.

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