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 C320E42DD9; Wed, 5 Jul 2023 13:11:13 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3A7B140A8B; Wed, 5 Jul 2023 13:11:13 +0200 (CEST) Received: from NAM04-DM6-obe.outbound.protection.outlook.com (mail-dm6nam04on2069.outbound.protection.outlook.com [40.107.102.69]) by mails.dpdk.org (Postfix) with ESMTP id C189840150 for ; Wed, 5 Jul 2023 13:11:11 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=mtduFyfhQMyWQkL+EwkNMKQum/Gci1hoX5p/WGcoMqWkQtch5q4LVyFXK3jbxv57KSNCCkq1y4WPc6jha8fUCezr3eNDEgfVGUqGHQljBZPW3UzE9LAmG47Tvr5N4prvzIrYKE96XSFgRy22Add1kKKGkW47LPfHhJQxxrke5qFNarTqu8qaKsOAaAH91Sov2e99JaI9Lkn+YGtJjDK6c0FpKJ8vjxBzLd9221tIDjJhiNpPbRpJ7yvakSo3Yx6/msidj18fYBmTRu3Ulhd611pDNDg1mfgYKWa+qzaJEqbGbeYdQie70aftZCpjJb2R2mYN70wDYQkK+n+pG2G+yA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; 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=2Ix1e3CzaSB8gP1aiECJTm4dMtJXcLd1hITVyInsdDc=; b=R0RNfN7Sp403SDJMTOMy8xz8U4Scfx5XLmqgD6Dm83s5JtlH3uKVCXudvDNblFXxHkXodYhxS7/p7R6x0z/vi6dIGOOTySKbx+ZYE66D4C70XIHL0Rq4Oaa+AEDVV9yljUylGYvljXf8LxAKquCCWMKnvHO4y6oVXmLqi/GJrDWIvNAg4xvriKWahqU30foNONsuf7iLhcpmy0ch0mQyFOl7TFui1syaVhwpI31uUtOF0lVaQzk8REgSudKXtwb0AExO335uMzhLDrMMJTBTUXMQh9MjP9C3WE/pw4uoNrYYSLVu9Co+LUPDjr9579tcq870UyhIs5CSPDLqNbb6wQ== 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 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=2Ix1e3CzaSB8gP1aiECJTm4dMtJXcLd1hITVyInsdDc=; b=bvVx6DrsdguX/52BJ1rPpxv1nljnO03nSmJ7oAMSSeCKkhwJp/a2YMB1SAC3iccf/QumSRpvEwuoktn/xAsxt45yFHi9YYnampikOp1HIWTNXhRbtxKGIt5qQsKeOaTnm1WaMK9Yv1FyOTWxV+KJZ+m4sC+/lTpm5LTiNKsbXOsvWRH3Cg+X2XC2VcGy9EEnHPwcz6QMjf1YwHpX9xiw4k9mUJtZU/2VOsr0Ec8mIHpZCZm6TYEp2eDmRLBY5e5gsfVLZU2bATe35eKHegw7nfvLO+UDH7r/UTNxQG6MpmIQL4oKQCqh/D4Um9m/zXeQykG2tkGJaKdC+jdXa/Nr2g== Received: from BN9PR03CA0512.namprd03.prod.outlook.com (2603:10b6:408:131::7) by CH0PR12MB8578.namprd12.prod.outlook.com (2603:10b6:610:18e::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6565.17; Wed, 5 Jul 2023 11:11:08 +0000 Received: from BN8NAM11FT075.eop-nam11.prod.protection.outlook.com (2603:10b6:408:131:cafe::41) by BN9PR03CA0512.outlook.office365.com (2603:10b6:408:131::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6565.18 via Frontend Transport; Wed, 5 Jul 2023 11:11:07 +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 BN8NAM11FT075.mail.protection.outlook.com (10.13.176.208) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6521.45 via Frontend Transport; Wed, 5 Jul 2023 11:11:07 +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.986.5; Wed, 5 Jul 2023 04:10:55 -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.986.37; Wed, 5 Jul 2023 04:10:53 -0700 From: Viacheslav Ovsiienko To: CC: , Subject: [PATCH v4 0/4] net/mlx5: introduce Tx datapath tracing Date: Wed, 5 Jul 2023 14:10:34 +0300 Message-ID: <20230705111038.9935-1-viacheslavo@nvidia.com> X-Mailer: git-send-email 2.18.1 In-Reply-To: <20230420100803.494-1-viacheslavo@nvidia.com> References: <20230420100803.494-1-viacheslavo@nvidia.com> MIME-Version: 1.0 Content-Type: text/plain 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: BN8NAM11FT075:EE_|CH0PR12MB8578:EE_ X-MS-Office365-Filtering-Correlation-Id: 9189839c-ea3f-42c6-fff4-08db7d488811 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: qh/NtliFb6j1AsWdla9sr0TWcTYuTXWPAg/+V/LZXlQusRrq3N77nuppwucW3yVL3V5JDTdQ7dhwGUQpEbDkey4hNO8c1DRyxS5x9B4PESgX5LFHPKTEa/gKi9l25fNRmYik8o+DPy2yKPRJIRldVUpHuz10crLbNXErGc7bWMIT82ZRhge+rBB29XGdkBe7/AU1wBPySUiqHLDLxaVLW1GkwFuFCCgaMPrg9952K0kP9AgSFBvmqzjAdiqMdablC81yaeSscjtWn5Q/91Hgfil6zeb+GSR4+FBjIiZdXYG13Pec5PDAouhUW0xt2qvZ/Q7kQ+A41h+exjhI6cVpev35UwDCWVUZoNETABJZU5ApHzg7mAGc6DAqqrEN/M2oMbWvvzrBItrsyOUooRHAcJ79Y9H66mojl0UFnWHtWXVbtuoaqd7JuIJ0yNUHwdMtDN5Co8aSLK7KJBGHYgx4FJTgYCR5a8AoR/9S00JXZ8ijP+C/qkyYTeepozMwJLkZ4HVFtlyb3GDRD1RmJwVE6nx0weLFJ/i0McAj/GeRBdlP2XC3SFGptHdVBOxVi+BtJV/h9Rq4N+2X90LFZdgSWBDo2Kd++B36Ye2VmjvKX3ERIDsKoRPj3rx+OWizpdFpZgudpMbw7INd/9JelmYj/zVw25sIBOLDtR8G1zrtNHonnNEU5n7NkCrDSXMQfdX3x7qjNhv0EqmNGLNVyqUVu29z15RLYTCCN7U0+sxQJ07clVRguz17Wl4c83FrBah3PhubqEYUBNSGz2rBTuMSi0F0+F3YBJ8eg8CUm17eXtA= 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:(13230028)(4636009)(39860400002)(376002)(136003)(346002)(396003)(451199021)(36840700001)(46966006)(40470700004)(40460700003)(4326008)(70586007)(70206006)(6916009)(356005)(7636003)(82740400003)(2616005)(82310400005)(107886003)(186003)(86362001)(6286002)(26005)(1076003)(36860700001)(16526019)(47076005)(83380400001)(336012)(426003)(6666004)(478600001)(966005)(7696005)(55016003)(40480700001)(54906003)(36756003)(41300700001)(8936002)(8676002)(2906002)(5660300002)(316002); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jul 2023 11:11:07.5024 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 9189839c-ea3f-42c6-fff4-08db7d488811 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: BN8NAM11FT075.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH0PR12MB8578 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 send scheduling on specific moment of time, and for the related kind of applications it would be extremely useful to have extra debug information - when and how packets were scheduled and when the actual sending was completed by the NIC hardware (it helps application to track the internal delay issues). Because the DPDK tx datapath API does not suppose getting any feedback from the driver and the feature looks like to be mlx5 specific, it seems to be reasonable to engage exisiting DPDK datapath tracing capability. The work cycle is supposed to be: - compile appplication with enabled tracing - run application with EAL parameters configuring the tracing in mlx5 Tx datapath - store the dump file with gathered tracing information - run analyzing scrypt (in Python) to combine related events (packet firing and completion) and see the data in human-readable view Below is the detailed instruction "how to" with mlx5 NIC to gather all the debug data including the full timings information. 1. Build DPDK application with enabled datapath tracing The meson option should be specified: --enable_trace_fp=true The c_args shoudl be specified: -DALLOW_EXPERIMENTAL_API The DPDK configuration examples: meson configure --buildtype=debug -Denable_trace_fp=true -Dc_args='-DRTE_LIBRTE_MLX5_DEBUG -DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build meson configure --buildtype=debug -Denable_trace_fp=true -Dc_args='-DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build meson configure --buildtype=release -Denable_trace_fp=true -Dc_args='-DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build meson configure --buildtype=release -Denable_trace_fp=true -Dc_args='-DALLOW_EXPERIMENTAL_API' build 2. Configuring the NIC If the sending completion timings are important the NIC should be configured to provide realtime timestamps, the REAL_TIME_CLOCK_ENABLE NV settings parameter should be configured to TRUE, for example with command (and with following FW/driver reset): sudo mlxconfig -d /dev/mst/mt4125_pciconf0 s REAL_TIME_CLOCK_ENABLE=1 3. Run DPDK application to gather the traces EAL parameters controlling trace capability in runtime --trace=pmd.net.mlx5.tx - the regular expression enabling the tracepoints with matching names at least "pmd.net.mlx5.tx" must be enabled to gather all events needed to analyze mlx5 Tx datapath and its timings. By default all tracepoints are disabled. --trace-dir=/var/log - trace storing directory --trace-bufsz=B|K|M - optional, trace data buffer size per thread. The default is 1MB. --trace-mode=overwrite|discard - optional, selects trace data buffer mode. 4. Installing or Building Babeltrace2 Package The gathered trace data can be analyzed with a developed Python script. To parse the trace, the data script uses the Babeltrace2 library. The package should be either installed or built from source code as shown below: git clone https://github.com/efficios/babeltrace.git cd babeltrace ./bootstrap ./configure -help ./configure --disable-api-doc --disable-man-pages --disable-python-bindings-doc --enbale-python-plugins --enable-python-binding 5. Running the Analyzing Script The analyzing script is located in the folder: ./drivers/net/mlx5/tools It requires Python3.6, Babeltrace2 packages and it takes the only parameter of trace data file. For example: ./mlx5_trace.py /var/log/rte-2023-01-23-AM-11-52-39 6. Interpreting the Script Output Data All the timings are given in nanoseconds. The list of Tx (and coming Rx) bursts per port/queue is presented in the output. Each list element contains the list of built WQEs with specific opcodes, and each WQE contains the list of the encompassed packets to send. Signed-off-by: Viacheslav Ovsiienko -- v2: - comment addressed: "dump_trace" command is replaced with "save_trace" - Windows build failure addressed, Windows does not support tracing v3: - tracepoint routines are moved to the net folder, no need to export - documentation added - testpmd patches moved out from series to the dedicated patches v4: - Python comments addressed - codestyle issues fixed Viacheslav Ovsiienko (4): net/mlx5: introduce tracepoints for mlx5 drivers net/mlx5: add comprehensive send completion trace net/mlx5: add Tx datapath trace analyzing script doc: add mlx5 datapath tracing feature description doc/guides/nics/mlx5.rst | 78 +++++++ drivers/net/mlx5/linux/mlx5_verbs.c | 8 +- drivers/net/mlx5/mlx5_devx.c | 8 +- drivers/net/mlx5/mlx5_rx.h | 19 -- drivers/net/mlx5/mlx5_rxtx.h | 19 ++ drivers/net/mlx5/mlx5_tx.c | 29 +++ drivers/net/mlx5/mlx5_tx.h | 135 +++++++++++- drivers/net/mlx5/tools/mlx5_trace.py | 307 +++++++++++++++++++++++++++ 8 files changed, 574 insertions(+), 29 deletions(-) create mode 100755 drivers/net/mlx5/tools/mlx5_trace.py -- 2.18.1