From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id F21C145B0B; Fri, 11 Oct 2024 03:38:41 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AFF53402E1; Fri, 11 Oct 2024 03:38:41 +0200 (CEST) Received: from mail-pf1-f178.google.com (mail-pf1-f178.google.com [209.85.210.178]) by mails.dpdk.org (Postfix) with ESMTP id 0041A402D3 for ; Fri, 11 Oct 2024 03:38:40 +0200 (CEST) Received: by mail-pf1-f178.google.com with SMTP id d2e1a72fcca58-71dfc250001so1346399b3a.2 for ; Thu, 10 Oct 2024 18:38:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1728610720; x=1729215520; darn=dpdk.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=cJHz9v2MZIcHYCGLqTeLsoNLi1EAHNzggTBzSLPLyzY=; b=vNioYpj+Jxb9gu6KHY59XUSo4/idy4rmV/e+EeRSyn/JNY3x9E5SEIn/rlsuMTbB+6 WPzI53ePub25S1kkCOYNrGoluvJGvf7QaWVw1pd/Eag05upxuwCLcPdGC3u+LSPNR9d6 Ck/CFalRTEei9utE8MQbJA36LGvPuPFMY14aji2+2Jpit7rVqQTqpwBOMj1pgYB4JeYU seASUN2mrT+0rqAr3Y2Xi48DTo3TqzhLiTRbFEwD8JRsVvNtF/4A177w4rAahA/u+vsx kVwR5sCXKiid8qcvpKcEbCIQybxJ4DzMSZ2Fv1axDt6EU5bJHwL7xAY8NYdOrkwgLyAk ryKg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1728610720; x=1729215520; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=cJHz9v2MZIcHYCGLqTeLsoNLi1EAHNzggTBzSLPLyzY=; b=cPfh/mdlIDmaCjGWu+BWt748TSwtWU00pgwfa40IwlbFAh26N9ATcM5Rg8Hw5wb3Aj 05PWEGiLak6/jyQEeXKS4t21trQsOHttzcUNhl85aX8On/UVUDi4hhiqMQjAFJDiZLMz 6sIx8w25FrxfIhNUdZBXpw1OSvDqavlBy5qX0I095GTIVaVhdyq1pWj2ZNBHA11jb3Xz PByBDqBMI1aC1gVlGSGzuHCXFHJaPzHT6cx5ldVkippONhDUgZkwuNYmZibTE2Ec4OzM zqnf5VbVk4te8Y2sEaw8afh7I3JCv3W+JoMWV7jRm7MIRqUx2JPfqllTnA3FFZfwFOIR UNXA== X-Gm-Message-State: AOJu0YwwqqKMCz059kFDr7lNS5TEOcN2Fgq2sMS7H3Sv11GVpwyrAvIz SMCx4rdrhIoKIlPsusAaUQE+5I6NTVCSGLs8xaFhOVgkoSq8dw+dd0B6HbFmrLiGZJ41ZpsrekM B X-Google-Smtp-Source: AGHT+IHPevlkWx0OXxvK1m+r+u0uQotHLPLekK4sX3DPZWN65KtMn3oXRHP1pg3uajDVpy7S75iL2Q== X-Received: by 2002:a05:6a00:1390:b0:71e:ba5:821b with SMTP id d2e1a72fcca58-71e3806bfefmr1407194b3a.27.1728610720047; Thu, 10 Oct 2024 18:38:40 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-71e2aaba376sm1665090b3a.158.2024.10.10.18.38.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 10 Oct 2024 18:38:39 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , ferruh.yigit@intel.com, Shreyansh Jain , John McNamara , Andrew Rybchenko Subject: [PATCH] doc: correct definition of Stats per queue feature Date: Thu, 10 Oct 2024 18:38:27 -0700 Message-ID: <20241011013827.5945-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.45.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Change the documentation to match current usage of this feature in the NIC table. Moved this sub heading to be after basic stats because the queue stats reported now are in the same structure. Although the "Stats per Queue" feature was originally intended to be related to stats mapping, the overwhelming majority of drivers report this feature with a different meaning. Hopefully in later release the per-queue stats limitations can be fixed, but this requires and API, ABI, and lots of driver changes. Fixes: dad1ec72a377 ("doc: document NIC features") Cc: ferruh.yigit@intel.com Signed-off-by: Stephen Hemminger --- doc/guides/nics/features.rst | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index cd0115ffb3..18ac82c466 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -727,13 +727,29 @@ Basic stats Support basic statistics such as: ipackets, opackets, ibytes, obytes, imissed, ierrors, oerrors, rx_nombuf. -And per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors. - These apply to all drivers. * **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``. * **[related] API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``. +.. _nic_features_stats_per_queue: + +Stats per queue +--------------- + +Supports per queue stats: q_ipackets, q_opackets, q_ibytes, q_obytes, q_errors. +Statistics only supplied for first RTE_ETHDEV_QUEUE_STAT_CNTRS (16) queues. +If driver does not support this feature the per queue stats will be zero. + +* **[implements] eth_dev_ops**: ``stats_get``, ``stats_reset``. +* **[related] API**: ``rte_eth_stats_get``, ``rte_eth_stats_reset()``. + +May also support configuring per-queue stat counter mapping. +Used by some drivers to workaround HW limitations. + +* **[implements] eth_dev_ops**: ``queue_stats_mapping_set``. +* **[related] API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``, + ``rte_eth_dev_set_tx_queue_stats_mapping()``. .. _nic_features_extended_stats: @@ -749,18 +765,6 @@ Supports Extended Statistics, changes from driver to driver. ``rte_eth_xstats_get_names_by_id()``, ``rte_eth_xstats_get_id_by_name()``. -.. _nic_features_stats_per_queue: - -Stats per queue ---------------- - -Supports configuring per-queue stat counter mapping. - -* **[implements] eth_dev_ops**: ``queue_stats_mapping_set``. -* **[related] API**: ``rte_eth_dev_set_rx_queue_stats_mapping()``, - ``rte_eth_dev_set_tx_queue_stats_mapping()``. - - .. _nic_features_congestion_management: Congestion management -- 2.45.2