man-pages/man8/rdma-statistic.8.html
2021-03-31 01:06:50 +01:00

321 lines
6.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of RDMA-STATISTIC</TITLE>
</HEAD><BODY>
<H1>RDMA-STATISTIC</H1>
Section: Linux (8)<BR>Updated: 27 June 2019<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
rdma-statistic - RDMA statistic counter configuration
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<BR>
<B>rdma</B>
[ <I>OPTIONS</I> ]
<B>statistic</B>
{ <I>COMMAND</I> |
<B>help</B> }
<P>
<P>
<BR>
<B>rdma statistic</B>
{ <I>OBJECT</I> }
<B>show</B>
<P>
<BR>
<B>rdma statistic</B>
[ <I>OBJECT</I> ]
<B>show link</B>
[ <I>DEV/PORT_INDX</I> ]
<P>
<BR>
<B>rdma statistic</B>
<I>OBJECT</I>
<B>mode</B>
<P>
<BR>
<B>rdma statistic</B>
<I>OBJECT</I>
<B>set</B>
<I>COUNTER_SCOPE</I>
[ <I>DEV/PORT_INDEX</I>]
<B>auto</B>
{ <I>CRITERIA</I> |
<B>off</B> }
<P>
<BR>
<B>rdma statistic</B>
<I>OBJECT</I>
<B>bind</B>
<I>COUNTER_SCOPE</I>
[ <I>DEV/PORT_INDEX</I>]
[ <I>OBJECT-ID</I> ]
[ <I>COUNTER-ID</I> ]
<P>
<BR>
<B>rdma statistic</B>
<I>OBJECT</I>
<B>unbind</B>
<I>COUNTER_SCOPE</I>
[ <I>DEV/PORT_INDEX</I>]
[ <I>COUNTER-ID</I> ]
[ <I>OBJECT-ID</I> ]
<P>
<BR>
<I>COUNTER_SCOPE</I> :=
{ <B>link</B> | <B>dev</B> }
<P>
<BR>
<I>OBJECT</I> :=
{ <B>qp</B> | <B>mr</B> }
<P>
<BR>
<I>CRITERIA</I> :=
{ <B>type</B> }
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<A NAME="lbAE">&nbsp;</A>
<H3>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</H3>
<P>
<P>
<I>DEV</I>
- specifies counters on this RDMA device to show.
<P>
<I>PORT_INDEX</I>
- specifies counters on this RDMA port to show.
<P>
<A NAME="lbAF">&nbsp;</A>
<H3>rdma statistic &lt;object&gt; set - configure counter statistic auto-mode for a specific device/port</H3>
In auto mode all objects belong to one category are bind automatically to a single counter set. Not applicable for MR's.
<P>
<A NAME="lbAG">&nbsp;</A>
<H3>rdma statistic &lt;object&gt; bind - manually bind an object (e.g., a qp) with a counter</H3>
When bound the statistics of this object are available in this counter. Not applicable for MR's.
<P>
<A NAME="lbAH">&nbsp;</A>
<H3>rdma statistic &lt;object&gt; unbind - manually unbind an object (e.g., a qp) from the counter previously bound</H3>
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.
<P>
<I>COUNTER-ID</I>
- specifies the id of the counter to be bound.
If this argument is omitted then a new counter will be allocated.
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
rdma statistic show
<DL COMPACT><DT id="1"><DD>
Shows the state of the default counter of all RDMA devices on the system.
</DL>
<P>
rdma statistic show link mlx5_2/1
<DL COMPACT><DT id="2"><DD>
Shows the state of the default counter of specified RDMA port
</DL>
<P>
rdma statistic qp show
<DL COMPACT><DT id="3"><DD>
Shows the state of all qp counters of all RDMA devices on the system.
</DL>
<P>
rdma statistic qp show link mlx5_2/1
<DL COMPACT><DT id="4"><DD>
Shows the state of all qp counters of specified RDMA port.
</DL>
<P>
rdma statistic qp show link mlx5_2 pid 30489
<DL COMPACT><DT id="5"><DD>
Shows the state of all qp counters of specified RDMA port and belonging to pid 30489
</DL>
<P>
rdma statistic qp mode
<DL COMPACT><DT id="6"><DD>
List current counter mode on all devices
</DL>
<P>
rdma statistic qp mode link mlx5_2/1
<DL COMPACT><DT id="7"><DD>
List current counter mode of device mlx5_2 port 1
</DL>
<P>
rdma statistic qp set link mlx5_2/1 auto type on
<DL COMPACT><DT id="8"><DD>
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 &quot;type&quot; is supported.
</DL>
<P>
rdma statistic qp set link mlx5_2/1 auto off
<DL COMPACT><DT id="9"><DD>
Turn-off auto mode on device mlx5_2 port 1. The allocated counters can be manually accessed.
</DL>
<P>
rdma statistic qp bind link mlx5_2/1 lqpn 178
<DL COMPACT><DT id="10"><DD>
On device mlx5_2 port 1, allocate a counter and bind the specified qp on it
</DL>
<P>
rdma statistic qp unbind link mlx5_2/1 cntn 4 lqpn 178
<DL COMPACT><DT id="11"><DD>
On device mlx5_2 port 1, bind the specified qp on the specified counter
</DL>
<P>
rdma statistic qp unbind link mlx5_2/1 cntn 4
<DL COMPACT><DT id="12"><DD>
On device mlx5_2 port 1, unbind all QPs on the specified counter. After that this counter will be released automatically by the kernel.
</DL>
<P>
rdma statistic show mr
<DL COMPACT><DT id="13"><DD>
List all currently allocated MR's and their counters.
</DL>
<P>
rdma statistic show mr mrn 6
<DL COMPACT><DT id="14"><DD>
Dump a specific MR statistics with mrn 6. Dumps nothing if does not exists.
</DL>
<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?8+rdma">rdma</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+rdma-dev">rdma-dev</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+rdma-link">rdma-link</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+rdma-resource">rdma-resource</A></B>(8),
<BR>
<P>
<A NAME="lbAK">&nbsp;</A>
<H2>AUTHORS</H2>
Mark Zhang &lt;<A HREF="mailto:markz@mellanox.com">markz@mellanox.com</A>&gt;
<BR>
Erez Alfasi &lt;<A HREF="mailto:ereza@mellanox.com">ereza@mellanox.com</A>&gt;
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="15"><A HREF="#lbAB">NAME</A><DD>
<DT id="16"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="17"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DL>
<DT id="18"><A HREF="#lbAE">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</A><DD>
<DT id="19"><A HREF="#lbAF">rdma statistic &lt;object&gt; set - configure counter statistic auto-mode for a specific device/port</A><DD>
<DT id="20"><A HREF="#lbAG">rdma statistic &lt;object&gt; bind - manually bind an object (e.g., a qp) with a counter</A><DD>
<DT id="21"><A HREF="#lbAH">rdma statistic &lt;object&gt; unbind - manually unbind an object (e.g., a qp) from the counter previously bound</A><DD>
</DL>
<DT id="22"><A HREF="#lbAI">EXAMPLES</A><DD>
<DT id="23"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="24"><A HREF="#lbAK">AUTHORS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:15 GMT, March 31, 2021
</BODY>
</HTML>