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 D3B7545C1D; Thu, 31 Oct 2024 09:05:27 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BBF404355A; Thu, 31 Oct 2024 09:05:27 +0100 (CET) Received: from NAM10-DM6-obe.outbound.protection.outlook.com (mail-dm6nam10on2080.outbound.protection.outlook.com [40.107.93.80]) by mails.dpdk.org (Postfix) with ESMTP id DCA2743541 for ; Thu, 31 Oct 2024 09:05:25 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=XcDrnwJGxagTwSl1/Qyxs0p+hIC84S3P/Khv1XIZ0CjNavJX0I/OGqNEFROEe7eHG6IVCuvjwdcCPKDtk/LfT8OaQXqqTCdt3CRJ8mSANVJoGfOTSq6ptyKVQsh+UwdskPOSO4S/U/9JAL4eSsjlGtgyrKxl4Ay6bUg2UYQqZIQmR4H22bWc5Y9bcrKjmNpQGlXkak7e8nZ4W8Eto88uV0v7yqDThshquEVAEap8Ykb77AM1OLH90kPnp9W9RaTe4O6fWroN4xKONKCZ4YCvC2IxcQvfVvIy2VTotAyGwJAZDtgBa/Rcvvl8sf7jJ/XSi2vZ8uMCGyJoK/PyHpESAQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=bnB51h/f3V701QxDzu9GCVyypc0I/qe5Lzxn/Pd18eA=; b=tCeYqQTAsGjciggGAn7N+VwffOc+jFJNtHY94clYLqHS/+DP/sohlFz87JdRlbpEYdCoVHdnKHfoSOhoecwQLF/RPkV3IMu+kczqFONWFaFH6tN+tVV97UDXnAbT1KmV5damO2JQsM1bCIC7xK0UNHJVeGE9FZ4T9sYEdWOj1v+R9VmqIkFcjI98Ub/t18+loz9IEL2PRtVTHC181t6lNJcVCjmVvyipZmejLstNTYfzf1U74oLrtPLCYb0y/DF1fc3Ob0sccsHU7RK77Cf5iQcowFC9DXx7/FGh2Rq0OKg1OIRCm2uQ/j7+mqAobhrVqMS5UZZt0SCwT0VP6NJXfQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.161) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=bnB51h/f3V701QxDzu9GCVyypc0I/qe5Lzxn/Pd18eA=; b=ByFlPpxEh1unCAXoVRQFLwPlgVDi1rtbJG3MEw/0C1hn0yrWLfDGL7dLpWFNDCHJ9o6sQQ2CIzIAYd0X1ZyQhqz5B36TywWV+nZRqAS8Z9g2TP5p5V+aQzhXoeqInpfTFHmwb/1EBVhgW4/ZUVKKDjyfQ1Y3zQAAVC7cQ6/4+aEOaI/dXcrL+t7CKQgRUsrNTWZc3Rg+fLptumsxwt3PKBZiVPu6QnS5xlTELIa4KZAxdWPp54YtaCkDF52vcPesGkZH7S01hy7H04uLGKyrTeHD3O/xRRIxpZp4dxwbjG5XrgFISj0hTY6kie30KEhVI6uA1jgStxB4nr74m473bg== Received: from BY5PR16CA0014.namprd16.prod.outlook.com (2603:10b6:a03:1a0::27) by IA1PR12MB8540.namprd12.prod.outlook.com (2603:10b6:208:454::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8093.32; Thu, 31 Oct 2024 08:05:23 +0000 Received: from SJ1PEPF000023D8.namprd21.prod.outlook.com (2603:10b6:a03:1a0:cafe::20) by BY5PR16CA0014.outlook.office365.com (2603:10b6:a03:1a0::27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8093.25 via Frontend Transport; Thu, 31 Oct 2024 08:05:22 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.161) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.117.161 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.161) by SJ1PEPF000023D8.mail.protection.outlook.com (10.167.244.73) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8137.0 via Frontend Transport; Thu, 31 Oct 2024 08:05:22 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com (10.129.200.67) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Thu, 31 Oct 2024 01:05:04 -0700 Received: from nvidia.com (10.126.230.35) by rnnvmail201.nvidia.com (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Thu, 31 Oct 2024 01:05:02 -0700 From: Viacheslav Ovsiienko To: CC: , , , Subject: [PATCH v2] doc: add mlx5 xstats send scheduling counters description Date: Thu, 31 Oct 2024 10:04:38 +0200 Message-ID: <20241031080438.1701634-1-viacheslavo@nvidia.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241028085708.0060bc6f@hermes.local> References: <20241028085708.0060bc6f@hermes.local> MIME-Version: 1.0 Content-Type: text/plain; charset="yes" Content-Transfer-Encoding: 8bit X-Originating-IP: [10.126.230.35] X-ClientProxiedBy: rnnvmail203.nvidia.com (10.129.68.9) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ1PEPF000023D8:EE_|IA1PR12MB8540:EE_ X-MS-Office365-Filtering-Correlation-Id: eca2b366-13dc-4165-5f49-08dcf982c4f3 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|36860700013|376014|82310400026; X-Microsoft-Antispam-Message-Info: =?us-ascii?Q?AzxBSPlik4mBO7b6c866geZ9A8zvclIn5PS0/6QkFEcSF0sC7ksTbWC8nc4G?= =?us-ascii?Q?oDXTJ5145Ugn4hBQMjqd9jx3wi0tjPrHT/mJQ1d1R3YjyKjy099J3ky7MFJq?= =?us-ascii?Q?aNn9NDGcckXXT8MIthjBwXrFIf68DqlFOoZGq55zxKDi67/W6uYSefmYCA5O?= =?us-ascii?Q?0oyxwNDjqwJpKfxtWOhTzst781QJJ6FrVyyCFEHLEIbHj1tpR3zZJmtVHc5u?= =?us-ascii?Q?6plZ3hlUeFGAG9jJPpdBI2Q8j7FsSCq5kmjJxKLkH70PyHb0S26RioP4aSLk?= =?us-ascii?Q?aBF/0AGiahZwRqSSvdPhgqxpQPD3SDxaqeiwO9ymEt/8ycjBF9McLktY2Uu4?= =?us-ascii?Q?9bPQzhtLLsoU3OtgrYlVZ1tK3+WzCRoKhR/Xs0jyg61muFExrA1gs5PjsaSX?= =?us-ascii?Q?S3ZfqQWwJ2tz7HlEoYAp0Wx3IgESHy0iAHz8qCu4PmTt22u9yU9t3OjUujUp?= =?us-ascii?Q?s99cbW3MWWcQhvTjaxrIVEgnQQG6LZnNE3t61eK0q2w/jsCD377i6pco/IiP?= =?us-ascii?Q?+m3uEpwVE1s46v2Lx7aDXG7jt6f9BlpMTXXEEEdjsBGQ9vciUGAwfUrnFDTq?= =?us-ascii?Q?cNjVP5Yoe5zXN5xLicX/oOtloiVtabWchQTTLuqMZznPiA0C08K0WnZnTBSm?= =?us-ascii?Q?vYjbD6KTapDQXiKTQTAn21UMwkisMv6AuQDBrIaRStBJ6FWqOXaw3QojEIfF?= =?us-ascii?Q?mc33BtvCSwojYrDkPma438m8vjvcMnlKJxiKpT63SNmPFDMocz0mLHZEVGgz?= =?us-ascii?Q?Pcl+YDRoGKTl57xmQ92zZM84AXmCr3iVQgsQSXxjcxN6LYdOCtuP3yk0pQMy?= =?us-ascii?Q?1G9QDR0H4pgLpkcxgW8QJDPBIhrDrzt9kcprp57NW9Z7aa4VHFSrtbiz2UUp?= =?us-ascii?Q?sBDX7FYYgd2zEulpThxdeNUFnXgNa9/m84EA8VhdzEabsfz5t0yxxjLeg4IG?= =?us-ascii?Q?udCgwx+Nvle82F177FNlWEo/VAxOFk5U++FIuY4yzO3x/4Ds0Ae5vN8IE7T3?= =?us-ascii?Q?KT4AERzptLeHDpsCCeMgVyCDVQBa63CyTS29M0Ote5j+ZZUUQ4a44dDTJXme?= =?us-ascii?Q?iqDPmSoiz0J4qTvxCjMTTQYNX3i0DIv8kynkT5Kx0TQx2PllzjCijJz1C2VV?= =?us-ascii?Q?124V1yPaYND6NAKgmvjOImJsnUyWT++t3wHE1eOy84Uf+0IVP4LqTMSq8riN?= =?us-ascii?Q?6+HKI2b0IZxjOl3qxRWsNsBhgVgWwPsSr2NtQ2PI//qQk9Skqmhig7sYEayc?= =?us-ascii?Q?J692C59pcbnjRJkmsGdRutTCs4Lc0VW0gfQYUw49b2FxCtwyBOoDnQIQnE6+?= =?us-ascii?Q?dhWNAOo6F6fXLmyNCTQjj5gaQbYBVjUijJlnOfkXN7TAV5PkgfASS7TQRZS0?= =?us-ascii?Q?rdrDfzTaWhbB/hcaAdKaGrdwZTpSAnPZZgxYR1QSOn7heqLX0A=3D=3D?= X-Forefront-Antispam-Report: CIP:216.228.117.161; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge2.nvidia.com; CAT:NONE; SFS:(13230040)(1800799024)(36860700013)(376014)(82310400026); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Oct 2024 08:05:22.3866 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: eca2b366-13dc-4165-5f49-08dcf982c4f3 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.161]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: SJ1PEPF000023D8.namprd21.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR12MB8540 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 The mlx5 provides the scheduling send on time capability. To check the operating status of this feature the extended statistics counters are provided. This patch adds the counter descriptions and provides some meaningful information how to interpret the counter values in runtime. Signed-off-by: Viacheslav Ovsiienko --- doc/guides/nics/mlx5.rst | 59 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index b5522d50c5..5db4aeda1b 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -2662,3 +2662,62 @@ Destroy GENEVE TLV parser for specific port:: This command doesn't destroy the global list, For releasing options, ``flush`` command should be used. + + +Extended Statistics Counters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Send Scheduling Extended Statistics Counters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The mlx5 PMD provides a comprehensive set of counters designed for debugging +and diagnostics related to packet scheduling during transmission. These counters +are applicable only if the port was configured with the ``tx_pp`` devarg and +reflect the status of the PMD scheduling infrastructure based on Clock and +Rearm Queues, used as a workaround on ConnectX-6DX NICs. + +- ``tx_pp_missed_interrupt_errors`` - indicates that the Rearm Queue interrupt + was not serviced on time. The EAL manages interrupts in a dedicated thread, + and it is possible that other time-consuming actions were being processed + concurrently. + +- ``tx_pp_rearm_queue_errors`` - signifies hardware errors that occurred + on the Rearm Queue, typically caused by delays in servicing interrupts. + +- ``tx_pp_clock_queue_errors`` - reflects hardware errors on the Clock Queue, + which usually indicate configuration issues or problems with the internal NIC + hardware or firmware. + +- ``tx_pp_timestamp_past_errors`` - tracks the application attempted to send + packets with timestamps set in the past. It is useful for debugging application + code and does not indicate a malfunction of the PMD. + +- ``tx_pp_timestamp_future_errors`` - records attempts by the application to send + packets with timestamps set too far into the future, exceeding the hardware’s + scheduling capabilities. Like the previous counter, it aids in application + debugging without suggesting a PMD malfunction. + +- ``tx_pp_jitter`` - measures the internal NIC real-time clock jitter estimation + between two consecutive Clock Queue completions, expressed in nanoseconds. + Significant jitter may signal potential clock synchronization issues, + possibly due to inappropriate adjustments made by a system PTP + (Precision Time Protocol) agent. + +- ``tx_pp_wander`` - indicates the long-term stability of the internal NIC + real-time clock over 2^24 completions, measured in nanoseconds. Significant + wander may also suggest clock synchronization problems. + +- ``tx_pp_sync_lost`` - a general operational indicator; a non-zero value + indicates that the driver has lost synchronization with the Clock Queue, + resulting in improper scheduling operations. To restore correct scheduling + functionality, it is necessary to restart the port. + +The following counters are particularly valuable for verifying and debugging +application code. They do not indicate driver or hardware malfunctions and +are applicable to newer hardware with direct on-time scheduling capabilities +(such as ConnectX-7 and above): + +- ``tx_pp_timestamp_order_errors`` - indicates attempts by the application + to send packets with timestamps that are not in strictly ascending order. + Since the PMD does not reorder packets within hardware queues, violations + of timestamp order can lead to packets being sent at incorrect times. -- 2.34.1