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 AF03F45BB1; Mon, 28 Oct 2024 15:28:15 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3D50940E0B; Mon, 28 Oct 2024 15:28:15 +0100 (CET) Received: from NAM11-BN8-obe.outbound.protection.outlook.com (mail-bn8nam11on2041.outbound.protection.outlook.com [40.107.236.41]) by mails.dpdk.org (Postfix) with ESMTP id A2409400D7 for ; Mon, 28 Oct 2024 15:28:13 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=jZnsYApNm61pNrlpO/AGNVPQHC883nGFq50MeMzQrSNtvyZ2QdSFzQ1jDUOcCNkSk4hGqTC2KYottFwVEaXNipeWbTEh9hKBQPHNGPu5pbpBXHKbUaUnEXcZW5ApOpKKyoxqvOWsYdvpqo1s1NMT/7arvaaN2OzKHsVE84v66dKF87wWks8Mmjul+Jequw+yZTV2dIGWaAmlTxZt7iTyac24zsU790zZ5zmnpP5JMOHzFO/CDfTp2mXexPTQTFP3wJ7PBIrdy8JAr3RcpI6hm9m3BlvgQzP33kl7vCvZEcrqoghgDf3bzHo5YFoKLGzIf5CRLrMUbObU5NVxYaB8RA== 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=GIbDFcWfttX6S2dh1Tqv2LTrwjW3UMPa1315DdCQhgA=; b=w/pkEUcFS5G6WbDGBxi1WlSBober0EpcsWjcjeV+a8KJeDOpGvWAAbxgyujStXl8lnISjRJg5Lk4H6CT5xe87z0Jh5jUbOIK2acVSJaqUisVg0WmV1NcoWz89vTAprKba4g/UOeebygb69F7bRcXbD5h3jntvkbc2Q2wFLQxBKzcU90zpY/+qlyg+VpRnlx843b5RSiA0/v0G3GyyTROx0rVlrBG6hsplNIlHTfF+LFh5hrb3/G1uEw/4du87UjDPS59b0qtZMXY3/xzw9SIWFEFrhWKr/+xG6yb9Bvoy/QyDt7FiGIPbgA2zR02MufJmXMBdkc+4ogvBiQPRP6c2A== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.160) 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=GIbDFcWfttX6S2dh1Tqv2LTrwjW3UMPa1315DdCQhgA=; b=dLZmMNirqo+2hsjTuhlTIdcYtM5H7447yLDZWLyIuD3Lir7et8bD2Dkk5KkHkU3gwkGRevgbO94VmyNeWYRwKhKtzXsSH9r1pPpRlhFaHnsPSFMPSMq3LAyo85d8j4zAFdjH2oBeHQMYZPlbPgTqhnnFIRm0CnE4+Ar+8bGOXyJjiIZtRL2XtiXDzATlw+nBRVLVREpMgULB5rP1zE6X291tAnI3V54nCxDvKcpPgrcAc9LfjX082G8DzUFEgMeKZM1H6CWsbPRs2RSmjlWQGmL4UfUtXkX7HgCDzXyU3S8lbXdncRMYiV2Jky/RewFQwheI0petMXm43JWXVctdsA== Received: from SJ0PR03CA0247.namprd03.prod.outlook.com (2603:10b6:a03:3a0::12) by DM4PR12MB6422.namprd12.prod.outlook.com (2603:10b6:8:b9::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8093.25; Mon, 28 Oct 2024 14:28:07 +0000 Received: from SJ1PEPF000023CE.namprd02.prod.outlook.com (2603:10b6:a03:3a0:cafe::59) by SJ0PR03CA0247.outlook.office365.com (2603:10b6:a03:3a0::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8093.26 via Frontend Transport; Mon, 28 Oct 2024 14:28:07 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.160) 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.160 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.160; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.160) by SJ1PEPF000023CE.mail.protection.outlook.com (10.167.244.10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8114.16 via Frontend Transport; Mon, 28 Oct 2024 14:28:07 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com (10.129.200.66) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Mon, 28 Oct 2024 07:27:59 -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; Mon, 28 Oct 2024 07:27:57 -0700 From: Viacheslav Ovsiienko To: CC: , , Subject: [PATCH 1/1] doc: add mlx5 xstats send scheduling counters description Date: Mon, 28 Oct 2024 16:27:41 +0200 Message-ID: <20241028142741.1609088-1-viacheslavo@nvidia.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.126.230.35] X-ClientProxiedBy: rnnvmail202.nvidia.com (10.129.68.7) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ1PEPF000023CE:EE_|DM4PR12MB6422:EE_ X-MS-Office365-Filtering-Correlation-Id: c4d2e7bd-2748-4e2c-7cf3-08dcf75cbda6 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|82310400026|36860700013|376014; X-Microsoft-Antispam-Message-Info: =?us-ascii?Q?b/rU0z1zNVp6ltwW0b1CPr/S1rY9+2LG4STQGUC0ZlZFu+VpIiBxb56OTJeZ?= =?us-ascii?Q?eHcnHGwbUcYcduN4ICZbTFleWHJjOHiPSyylPYeOzymhqvTrAGyWdSFI4Q58?= =?us-ascii?Q?vLh9KiegZwyjfj94MqfLff5TWVFp0JTL2e/6gLlUrxh/s6ATuLU2Df8v9qXD?= =?us-ascii?Q?QClXW+9eCCxeD6rImUJSWcZtVJnqvTyVbCm9Jm56y3uqYmqNj2sVTHXJKL6/?= =?us-ascii?Q?5S5TCh/WcLEWhomlK8nINLpghUVX2Ys6OwQVJuT7CKNLIxePmWBQNbxtY5wf?= =?us-ascii?Q?ed34PD9hFXYMgTzZV7CJhyEdMDbiOzKYw49E1V7qw/8s371hc+fuFWvUTs2L?= =?us-ascii?Q?fiCH1z3s7SJp8w9tdCHI6nbGgZ29rMKpPc5nX+wJJ0qrD70oO4Z+EID9mOMT?= =?us-ascii?Q?aWxklUbbpdXlCh90tFW8iW8JDhWtziAe4qYHnODX7JIdR5tgn1f7epGgKgs2?= =?us-ascii?Q?ebuXnkDjV/HBkTm5FewLmQx3KuYyHMrlAbkDsAtZWmqJXk6oZ0Sr6PdGpuYl?= =?us-ascii?Q?BXlqkM/mmSh2ozfiX5B7v6tpYDPqjPlW6Mwf5HtzYVZQH+fKtfOwjL7ydsfO?= =?us-ascii?Q?tbzdpNLJ03F2hFctBDrIFbpXRWwJ9c6xEZwc0NxZf+/xdbPclZNYLFO9Wkuz?= =?us-ascii?Q?83PosHGo62ZQU8shHh8gta037aQ3yuMW47IHCoVVXk6X9r+hE1pRstSjLlB1?= =?us-ascii?Q?o7Kbg/6dfFAn5JqwetlBgTER9llzsREXld4MFtQnPR/cZViVhX+t4kJfVR00?= =?us-ascii?Q?4LHMAQFhm6XvdudBPs9ZqXYpD/VAQ2B+ENXq8fawXsGppO7F9Y777fgU7JPr?= =?us-ascii?Q?ueVxXD5h3IxSEWvppiF4na8HsT5ttSpZEYE38pFAnLzt9gou/X9tRvd5G9hY?= =?us-ascii?Q?h+eWKertLnnZ86PE5sg7GdYf37gfmY9W2pXHlzG9zJMudLkfr6Qx5X1fnVIo?= =?us-ascii?Q?q7cCPRX9ScYl5MXYRJS1Wf16oBH98ng5dxTh/ghmfmFyb6Z9aflD9fELn3Cr?= =?us-ascii?Q?sR14rMi3XpO/h61MSy6KbdrO3FY/WD32veFdcGQRdDSANE1kY3QE1dBorFzA?= =?us-ascii?Q?1Z7AEy3skZkMGtQUeRcMmI89EOtg7afckHdfmtm9qOR2AUsgC7zcqFowPYOF?= =?us-ascii?Q?BLTD0EkJT+M6ccRxHADEVY5dzBWG7DgPyfm2LTYuewirzFBLethdPAHX7ap0?= =?us-ascii?Q?UfXPWcJRVTE3eaf5b9ELul9P0OTjW4O79n1gXX4FXy7O/wuLofnRRvu59DM6?= =?us-ascii?Q?CdytIyQY0Cyx4oFwwQ1gk6hFRQc6jNlNk58ZYvTQgPiGGORCUDNgOEP2vz+c?= =?us-ascii?Q?gmehsXGnRd21sHChlG0jrf7i8gUgVx9OQY8Wq5udED19yLl6KvffWAyuqP38?= =?us-ascii?Q?saLIIFiiGsEV1J5tYzqLlkQh6OrGelFMQ2APvNm9n3c/HkSckA=3D=3D?= X-Forefront-Antispam-Report: CIP:216.228.117.160; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge1.nvidia.com; CAT:NONE; SFS:(13230040)(1800799024)(82310400026)(36860700013)(376014); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Oct 2024 14:28:07.0468 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: c4d2e7bd-2748-4e2c-7cf3-08dcf75cbda6 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.160]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: SJ1PEPF000023CE.namprd02.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR12MB6422 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. The check the operating status of this feature the xstats 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 | 48 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index f82e2d75de..8d1a1311d4 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -2655,3 +2655,51 @@ 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 related xstats counters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The mlx5 PMD provides the set of tx_pp feature related counters to provide debug and diagnostics +on send packet scheduling. These counters are applicable only if port was probed with ``tx_pp`` +devarg and reflect the status of PMD scheduling infrastructure based on Clock and Rearm Queues. +This infrastructure provedies the Send Scheduling capability on CX6DX NICs as temporary workaround +and should not be engaged on the newer hardware. + +- ``tx_pp_missed_interrupt_errors`` - the Rearm Queue interrupt was not serviced in time. EAL handles + interrupts in dedicated thread and, possible, there were another time-consuming actions were taken. + +- ``tx_pp_rearm_queue_errors`` - hardware errors occurred on Rearm Queue, usually it is caused by not + servicing interrupts in time + +- ``tx_pp_clock_queue_errors`` - hardware errors occurred on Clock Queue, usually it indicates some + configuration or internal NIC hardware or firmware issues + +- ``tx_pp_timestamp_past_errors`` - application tried to send packet(s) with specifying timestamp in the past. + This counter is useful to check and debug the application code, it does not indicate PMD malfunction. + +- ``tx_pp_timestamp_future_errors`` - application tried to send packet(s) with specifying timestamp + in the too distant future, beyond the hardware capabilities to schedule the sending + This counter is useful to check and debug the application code, it does not indicate PMD malfunction. + +- ``tx_pp_jitter`` - this counter exposes the internal NIC realtime clock jitter estimation between two + neighbour Clock Queue completions in nanoseconds. Significant jitter might alert about clock + synchronization issues (say, some system PTP agent might adjust NIC clock in inappropriate way) + +- ``tx_pp_wander`` - the counter exposes the longterm internal NUC realtime clock stability - tx_pp_wander + for 2^24 completions, in nanoseconds. Significant wander might indicate clock synchronization issues. + +- ``tx_pp_sync_lost`` - the general operating indicator, the non-zero value says the driver lost + the Clock Queue synchronization and scheduling does not operate correctly. The port must be restarted + to restore the correct scheduling functioning. + +The following counters are extremely useful for application code check and debug, these ones do not +indicate driver or hardware mulfunctions, and are also applicable for the newer hardware (with direct +on time scheduling capabilities - ConnectX-7 and above): + +- ``tx_pp_timestamp_order_errors`` - application tried to send packet(s) with timestamps in not + strictly ascending order. Because of PMD does not reorder packets in the hardware queues, scheduling + timestamps order violation causes sending packets in wrong moments of time. -- 2.34.1