[dpdk-dev,1/2] doc: update mlx5 statistics query

Message ID 20171129112908.29493-1-shahafs@mellanox.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Shahaf Shuler Nov. 29, 2017, 11:29 a.m. UTC
  Update the guide with more details on the different statistics query
possible with MLX5 PMD.

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
---
 doc/guides/nics/mlx5.rst | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
  

Comments

Nélio Laranjeiro Nov. 29, 2017, 12:14 p.m. UTC | #1
On Wed, Nov 29, 2017 at 01:29:07PM +0200, Shahaf Shuler wrote:
> Update the guide with more details on the different statistics query
> possible with MLX5 PMD.
> 
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> ---
>  doc/guides/nics/mlx5.rst | 13 +++++++++++--
>  1 file changed, 11 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index f9558da89..154db64d7 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -105,8 +105,6 @@ Limitations
>  -----------
>  
>  - Inner RSS for VXLAN frames is not supported yet.
> -- Port statistics through software counters only. Flow statistics are
> -  supported by hardware counters.
>  - Hardware checksum RX offloads for VXLAN inner header are not supported yet.
>  - Forked secondary process not supported.
>  - Flow pattern without any specific vlan will match for vlan packets as well:
> @@ -134,6 +132,17 @@ Limitations
>    to 0 are not supported.
>  - VXLAN TSO and checksum offloads are not supported on VM.
>  
> +Statistics
> +----------
> +
> +MLX5 supports various of methods to report statistics:
> +
> +Port statistics can be queried using ``rte_eth_stats_get()``. The port statistics are through SW only and counts the number of packets received or sent successfully by the PMD.
> +
> +Extended statistics can be queried using ``rte_eth_xstats_get()``. The extended statistics expose a wider set of counters counted by the device. The extended port statistics counts the number of packets received or sent successfully by the port. As Mellanox NICs are using the :ref:`Bifurcated Linux Driver <linux_gsg_linux_drivers>` those counters counts also packet received or sent by the Linux kernel. The counters with ``_phy`` suffix counts the total events on the physical port, therefore not valid for VF.
> +
> +Finally per-flow statistics can by queried using ``rte_flow_query`` when attaching a count action for specific flow. The flow counter counts the number of packets received successfully by the port and match the specific flow.
> +
>  Configuration
>  -------------
>  
> -- 
> 2.12.0
 
For the series,

Acked-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>

Thanks,
  
Shahaf Shuler Nov. 29, 2017, 1:34 p.m. UTC | #2
Wednesday, November 29, 2017 2:14 PM, Nelio Laranjeiro:
> On Wed, Nov 29, 2017 at 01:29:07PM +0200, Shahaf Shuler wrote:
> > Update the guide with more details on the different statistics query
> > possible with MLX5 PMD.
> >
> > Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> > ---
> >  doc/guides/nics/mlx5.rst | 13 +++++++++++--
> >  1 file changed, 11 insertions(+), 2 deletions(-)
> >
> For the series,
> 
> Acked-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>

Series applied to next-net-mlx5, thanks.

> 
> Thanks,
> 
> --
> Nélio Laranjeiro
> 6WIND
  

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index f9558da89..154db64d7 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -105,8 +105,6 @@  Limitations
 -----------
 
 - Inner RSS for VXLAN frames is not supported yet.
-- Port statistics through software counters only. Flow statistics are
-  supported by hardware counters.
 - Hardware checksum RX offloads for VXLAN inner header are not supported yet.
 - Forked secondary process not supported.
 - Flow pattern without any specific vlan will match for vlan packets as well:
@@ -134,6 +132,17 @@  Limitations
   to 0 are not supported.
 - VXLAN TSO and checksum offloads are not supported on VM.
 
+Statistics
+----------
+
+MLX5 supports various of methods to report statistics:
+
+Port statistics can be queried using ``rte_eth_stats_get()``. The port statistics are through SW only and counts the number of packets received or sent successfully by the PMD.
+
+Extended statistics can be queried using ``rte_eth_xstats_get()``. The extended statistics expose a wider set of counters counted by the device. The extended port statistics counts the number of packets received or sent successfully by the port. As Mellanox NICs are using the :ref:`Bifurcated Linux Driver <linux_gsg_linux_drivers>` those counters counts also packet received or sent by the Linux kernel. The counters with ``_phy`` suffix counts the total events on the physical port, therefore not valid for VF.
+
+Finally per-flow statistics can by queried using ``rte_flow_query`` when attaching a count action for specific flow. The flow counter counts the number of packets received successfully by the port and match the specific flow.
+
 Configuration
 -------------