linux-rdma.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Leon Romanovsky <leon@kernel.org>
To: David Ahern <dsahern@gmail.com>
Cc: Leon Romanovsky <leonro@mellanox.com>,
	netdev <netdev@vger.kernel.org>, Erez Alfasi <ereza@mellanox.com>,
	RDMA mailing list <linux-rdma@vger.kernel.org>,
	Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH iproute2-next 2/2] rdma: Document MR statistics
Date: Wed, 23 Oct 2019 13:38:54 +0300	[thread overview]
Message-ID: <20191023103854.5981-3-leon@kernel.org> (raw)
In-Reply-To: <20191023103854.5981-1-leon@kernel.org>

From: Erez Alfasi <ereza@mellanox.com>

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>
---
 man/man8/rdma-statistic.8 | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/man/man8/rdma-statistic.8 b/man/man8/rdma-statistic.8
index dea6ff24..541b5d63 100644
--- a/man/man8/rdma-statistic.8
+++ b/man/man8/rdma-statistic.8
@@ -1,4 +1,4 @@
-.TH RDMA\-STATISTIC 8 "17 Mar 2019" "iproute2" "Linux"
+.TH RDMA\-STATISTIC 8 "27 June 2019" "iproute2" "Linux"
 .SH NAME
 rdma-statistic \- RDMA statistic counter configuration
 .SH SYNOPSIS
@@ -15,7 +15,7 @@ rdma-statistic \- RDMA statistic counter configuration
 
 .ti -8
 .B rdma statistic
-.RI "[ " OBJECT " ]"
+.RI "{ " OBJECT " }"
 .B show
 
 .ti -8
@@ -63,7 +63,7 @@ rdma-statistic \- RDMA statistic counter configuration
 
 .ti -8
 .IR OBJECT " := "
-.RB "{ " qp " }"
+.RB "{ " qp " | " mr " }"
 
 .ti -8
 .IR CRITERIA " := "
@@ -80,13 +80,13 @@ rdma-statistic \- RDMA statistic counter configuration
 - 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.
+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.
+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.
+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.
@@ -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
 .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),
@@ -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
 
-.SH AUTHOR
+.SH AUTHORS
 Mark Zhang <markz@mellanox.com>
+.br
+Erez Alfasi <ereza@mellanox.com>
-- 
2.20.1


  parent reply	other threads:[~2019-10-23 10:39 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-23 10:38 [PATCH iproute2-next 0/2] Add MR counters statistics Leon Romanovsky
2019-10-23 10:38 ` [PATCH iproute2-next 1/2] rdma: Add "stat show mr" support Leon Romanovsky
2019-10-23 10:38 ` Leon Romanovsky [this message]
2019-10-27 17:25 ` [PATCH iproute2-next 0/2] Add MR counters statistics David Ahern

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191023103854.5981-3-leon@kernel.org \
    --to=leon@kernel.org \
    --cc=dsahern@gmail.com \
    --cc=ereza@mellanox.com \
    --cc=leonro@mellanox.com \
    --cc=linux-rdma@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).