From mboxrd@z Thu Jan 1 00:00:00 1970 From: Harry van Haaren Subject: [PATCH v2] docs: add statistics read frequency to fm10k guide Date: Tue, 9 Feb 2016 15:19:54 +0000 Message-ID: <1455031194-27921-1-git-send-email-harry.van.haaren@intel.com> References: <1454946137-5505-1-git-send-email-harry.van.haaren@intel.com> Cc: dev@dpdk.org To: jing.d.chen@intel.com Return-path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 795D58D28 for ; Tue, 9 Feb 2016 16:20:06 +0100 (CET) In-Reply-To: <1454946137-5505-1-git-send-email-harry.van.haaren@intel.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch documents that the statistics of fm10k based NICs must be read regularly in order to avoid an undetected 32 bit integer-overflow. Signed-off-by: Harry van Haaren --- v2: -Moved notes to Known Issues section of Release Notes. doc/guides/nics/fm10k.rst | 16 ++++++++++++++++ doc/guides/rel_notes/release_2_3.rst | 4 ++++ 2 files changed, 20 insertions(+) diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst index 4206b7f..4250c9e 100644 --- a/doc/guides/nics/fm10k.rst +++ b/doc/guides/nics/fm10k.rst @@ -65,3 +65,19 @@ The FM10000 family of NICS support a maximum of a 15K jumbo frame. The value is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len`` member of ``struct rte_eth_conf`` is set to a value lower than 15364, frames up to 15364 bytes can still reach the host interface. + +Statistic Polling Frequency +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The FM10000 NICs expose a set of statistics via the PCI BARs. These statistics +are read from the hardware registers when ``rte_eth_stats_get()`` or +``rte_eth_xstats_get()`` is called. The packet counting registers are 32 bits +while the byte counting registers are 48 bits. As a result, the statistics must +be polled regularly in order to ensure the consistency of the returned reads. + +Given the PCIe Gen3 x8, about 50Gbps of traffic can occur. With 64 byte packets +this gives almost 100 million packets/second, causing 32 bit integer overflow +after approx 40 seconds. To ensure these overflows are detected and accounted +for in the statistics, it is necessary to read statistic regularly. It is +suggested to read stats every 20 seconds, which will gaurantee the statistics +are accurate. diff --git a/doc/guides/rel_notes/release_2_3.rst b/doc/guides/rel_notes/release_2_3.rst index 99de186..6748b89 100644 --- a/doc/guides/rel_notes/release_2_3.rst +++ b/doc/guides/rel_notes/release_2_3.rst @@ -31,6 +31,10 @@ Other Known Issues ------------ +* **FM10K: Statistics Polling Frequency** + + A section has been added to the NIC guide for fm10k about the maximum + time between reading statistics and 32 bit packet counter overflows. API Changes ----------- -- 2.5.0