Cover Detail
Show a cover letter.
GET /api/covers/128636/?format=api
{ "id": 128636, "url": "http://patchwork.dpdk.org/api/covers/128636/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/cover/20230613165845.19109-1-viacheslavo@nvidia.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20230613165845.19109-1-viacheslavo@nvidia.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20230613165845.19109-1-viacheslavo@nvidia.com", "date": "2023-06-13T16:58:40", "name": "[v2,0/5] net/mlx5: introduce Tx datapath tracing", "submitter": { "id": 1926, "url": "http://patchwork.dpdk.org/api/people/1926/?format=api", "name": "Slava Ovsiienko", "email": "viacheslavo@nvidia.com" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/cover/20230613165845.19109-1-viacheslavo@nvidia.com/mbox/", "series": [ { "id": 28494, "url": "http://patchwork.dpdk.org/api/series/28494/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=28494", "date": "2023-06-13T16:58:42", "name": "net/mlx5: introduce Tx datapath tracing", "version": 2, "mbox": "http://patchwork.dpdk.org/series/28494/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/covers/128636/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 912E842CA7;\n\tTue, 13 Jun 2023 18:59:34 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id B60E742BAC;\n\tTue, 13 Jun 2023 18:59:23 +0200 (CEST)", "from NAM12-BN8-obe.outbound.protection.outlook.com\n (mail-bn8nam12on2046.outbound.protection.outlook.com [40.107.237.46])\n by mails.dpdk.org (Postfix) with ESMTP id 4886242BAC\n for <dev@dpdk.org>; Tue, 13 Jun 2023 18:59:22 +0200 (CEST)", "from BN7PR06CA0070.namprd06.prod.outlook.com (2603:10b6:408:34::47)\n by SA1PR12MB6846.namprd12.prod.outlook.com (2603:10b6:806:25d::14)\n with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6455.33; Tue, 13 Jun\n 2023 16:59:20 +0000", "from BN8NAM11FT103.eop-nam11.prod.protection.outlook.com\n (2603:10b6:408:34:cafe::22) by BN7PR06CA0070.outlook.office365.com\n (2603:10b6:408:34::47) with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6477.35 via Frontend\n Transport; Tue, 13 Jun 2023 16:59:20 +0000", "from mail.nvidia.com (216.228.117.161) by\n BN8NAM11FT103.mail.protection.outlook.com (10.13.176.181) with Microsoft SMTP\n Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id\n 15.20.6500.23 via Frontend Transport; Tue, 13 Jun 2023 16:59:20 +0000", "from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com\n (10.129.200.67) with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.5; Tue, 13 Jun 2023\n 09:59:02 -0700", "from nvidia.com (10.126.231.35) by rnnvmail201.nvidia.com\n (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37; Tue, 13 Jun\n 2023 09:59:01 -0700" ], "ARC-Seal": "i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;\n b=Y9dlw7th2rk3xLNGaa9yo/vwlnVLatK4CSaiWFICl4qsR5oGV5GWwmhYXjgN3cy98z6LhJnkc6V/nMHU4jxkfqQ3F07JPRQVUkHVSh77MGLaDLlqMOJLz5H+FjO1CyjzEVurPiR9sq5ZgXqLQmKR5K/q+yBTtHMz/5okQqq8rq3M4JfAxLRqB7ESK7cKkCi/rKlG4jjENhgoCMAmr9ocXo/jUj0zm20XIbPu3qkhZvW5GZhLZpF8SwamrBALUWM/EjMBMmMXTMck2axQ+Nkwxg29imQCN+bi+RghIO7+iAOSvz927KBUfbZYvoGeIG/CCTzHZzFMz3v6qJp3XevGZg==", "ARC-Message-Signature": "i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com;\n s=arcselector9901;\n 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;\n bh=hJmpgCOUvo4vsovc936/Fz7O/ThuFH2qt89oybPLb/M=;\n b=a5dAsJfGcwMmojlK0t4FhVp45wolvnskIGna3j1KZ9S1UEKPWz+nSz1GOlg5QjQrtRgnsRpFq8a9XyM56ySlLpxzuevtdUrSZB35Ifttz5BuGHNLGzed+urCGP08CF/RgQZl5oOSDz3KUaXVUOk8+2tp6oxOQ3v70gBFcWjqEZdepcGKRPHmzbA+fb6WfGYcKl8PpTf3gChLMhCK0+LqsIn9A7HPaKiTgOV1tt6YjGUpLkqGzFB1fDc4tugz8VlYdTSEFZFLevh7d334bxUu2aQCjRKNQdtjda8pcsERqtL25NvjDhUbP+ewjWexcTa45XmvNUSp3Oi1fQjpCA2pGA==", "ARC-Authentication-Results": "i=1; mx.microsoft.com 1; spf=pass (sender ip is\n 216.228.117.161) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com;\n dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com;\n dkim=none (message not signed); arc=none", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com;\n s=selector2;\n h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;\n bh=hJmpgCOUvo4vsovc936/Fz7O/ThuFH2qt89oybPLb/M=;\n b=iWst8QxbIDmP050iYMEMcaFfjYCejj0NwPxpHZ7z/hSbl/C8HiZMyacb5PU4ygrn/rLGRQ+NF2img11LZkbG+q+Oh7I/SkAa0jW74H9sRh6TZcWG/3mVFKSf18F6cCJGPiLSTMSYgnhkk7dulqqbmCSbFoYoZ0S0plvGMRpoak8C4yOjoQshCaVAmTE3/l4S1ntJm6Jecq3UJt8xI7Zj/afu3V479qWucncf+kQ4+cUC3Ai3EfSHzD9Pw27P/5sxLNCKqatncGv/010Br/qvOHIFfzRLdNvs34JucVA6lhMByyFDGySTCNSrZitaMKE1RWRoRWRtK5ZhEha+QiEhCw==", "X-MS-Exchange-Authentication-Results": "spf=pass (sender IP is 216.228.117.161)\n smtp.mailfrom=nvidia.com;\n dkim=none (message not signed)\n header.d=none;dmarc=pass action=none header.from=nvidia.com;", "Received-SPF": "Pass (protection.outlook.com: domain of nvidia.com designates\n 216.228.117.161 as permitted sender) receiver=protection.outlook.com;\n client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C", "From": "Viacheslav Ovsiienko <viacheslavo@nvidia.com>", "To": "<dev@dpdk.org>", "Subject": "[PATCH v2 0/5] net/mlx5: introduce Tx datapath tracing", "Date": "Tue, 13 Jun 2023 19:58:40 +0300", "Message-ID": "<20230613165845.19109-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.231.35]", "X-ClientProxiedBy": "rnnvmail203.nvidia.com (10.129.68.9) To\n rnnvmail201.nvidia.com (10.129.68.8)", "X-EOPAttributedMessage": "0", "X-MS-PublicTrafficType": "Email", "X-MS-TrafficTypeDiagnostic": "BN8NAM11FT103:EE_|SA1PR12MB6846:EE_", "X-MS-Office365-Filtering-Correlation-Id": "95a7c49a-1ec8-4b20-8288-08db6c2f880b", "X-MS-Exchange-SenderADCheck": "1", "X-MS-Exchange-AntiSpam-Relay": "0", "X-Microsoft-Antispam": "BCL:0;", "X-Microsoft-Antispam-Message-Info": "\n A2qZv88ivijdrf87kR6yCS5QS1PZOwdoPXvPB7dZCrPThfoe+ff4oNk1bcCTByB+mogTEwWsICpPUuEvuUSMQoHhsbCSj+Xjs5DK3faFMtf7DImqoWDPMirVoeNf9SW+0ELfrIOpRGn2dUqqBYcM5CjAxu6k+PG5/zvcV67jChfRtutAVxupVaf6HY7neKM0vtFZdYht10/D+G1WXa3abG39OCtkUPcxUnh3RNB0RzKGuvogKXZ5yPC/LpnwokKuxfTuNsoNn12/au/M4lgfs5eR5iGdYLpbwuukLWEw8KKBo3CWwWLkGcmgLuBBazTzX+7/pjXjNmFTV2nhYDoNQmRXV0UdKOAKMuK8/nulcRWw5nsB1kscvhmI9UtebiCVd2yJN3ay3Mm7D4RKQtPAax2lN+AEEW4SCxzzkEOuPMpweOmahEz9UGD50o2rFlWtcGw1exPXneHv2FAfUA6REMKaWXaZwRrZVWg3mbd8EHSzISj6iLPbWT5ZtxXVTkYOslrnH/sMj80RTetj1o3AUR+AfB9hWnbX+FhC04EidU1RsTguFO7ZJbyMtDcIHG/tKOHsir65RhwVWHtfxacwTrSEDR1ujjqIz7mayxtbj3XyLaL8i70JrrZtzjmYAtiFBNJYIm7PVnkt2ad2TBKbsCcSWy9UNJcTMx12wPfZmqlbB7yFbyI6jNDKW1QLpQeNgGb0Nou2ym8f9SnbwNBRPegCWRp3kgaA4Hcn6Qc59LQ8cAGtT2bYqJUmThVyN6XbvIX12Cw/ZZZ9muuu3XF896yoDqzLXt9KCfyOwP8PCHg=", "X-Forefront-Antispam-Report": "CIP:216.228.117.161; CTRY:US; LANG:en; SCL:1;\n SRV:;\n IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge2.nvidia.com; CAT:NONE;\n SFS:(13230028)(4636009)(39860400002)(346002)(396003)(376002)(136003)(451199021)(36840700001)(40470700004)(46966006)(8936002)(8676002)(5660300002)(316002)(6916009)(70586007)(70206006)(2906002)(41300700001)(36860700001)(966005)(6666004)(40460700003)(82740400003)(478600001)(7696005)(7636003)(40480700001)(55016003)(356005)(1076003)(426003)(336012)(26005)(16526019)(6286002)(186003)(36756003)(83380400001)(2616005)(47076005)(86362001)(82310400005);\n DIR:OUT; SFP:1101;", "X-OriginatorOrg": "Nvidia.com", "X-MS-Exchange-CrossTenant-OriginalArrivalTime": "13 Jun 2023 16:59:20.1494 (UTC)", "X-MS-Exchange-CrossTenant-Network-Message-Id": "\n 95a7c49a-1ec8-4b20-8288-08db6c2f880b", "X-MS-Exchange-CrossTenant-Id": "43083d15-7273-40c1-b7db-39efd9ccc17a", "X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp": "\n TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.161];\n Helo=[mail.nvidia.com]", "X-MS-Exchange-CrossTenant-AuthSource": "\n BN8NAM11FT103.eop-nam11.prod.protection.outlook.com", "X-MS-Exchange-CrossTenant-AuthAs": "Anonymous", "X-MS-Exchange-CrossTenant-FromEntityHeader": "HybridOnPrem", "X-MS-Exchange-Transport-CrossTenantHeadersStamped": "SA1PR12MB6846", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "The mlx5 provides the send scheduling on specific moment of time,\nand for the related kind of applications it would be extremely useful\nto have extra debug information - when and how packets were scheduled\nand when the actual sending was completed by the NIC hardware (it helps\napplication to track the internal delay issues).\n\nBecause the DPDK tx datapath API does not suppose getting any feedback\nfrom the driver and the feature looks like to be mlx5 specific, it seems\nto be reasonable to engage exisiting DPDK datapath tracing capability.\n\nThe work cycle is supposed to be:\n - compile appplication with enabled tracing\n - run application with EAL parameters configuring the tracing in mlx5\n Tx datapath\n - store the dump file with gathered tracing information\n - run analyzing scrypt (in Python) to combine related events (packet\n firing and completion) and see the data in human-readable view\n\nBelow is the detailed instruction \"how to\" with mlx5 NIC to gather\nall the debug data including the full timings information.\n\n\n1. Build DPDK application with enabled datapath tracing\n\nThe meson option should be specified:\n --enable_trace_fp=true\n\nThe c_args shoudl be specified:\n -DALLOW_EXPERIMENTAL_API\n\nThe DPDK configuration examples:\n\n meson configure --buildtype=debug -Denable_trace_fp=true\n -Dc_args='-DRTE_LIBRTE_MLX5_DEBUG -DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build\n\n meson configure --buildtype=debug -Denable_trace_fp=true\n -Dc_args='-DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build\n\n meson configure --buildtype=release -Denable_trace_fp=true\n -Dc_args='-DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build\n\n meson configure --buildtype=release -Denable_trace_fp=true\n -Dc_args='-DALLOW_EXPERIMENTAL_API' build\n\n\n2. Configuring the NIC\n\nIf the sending completion timings are important the NIC should be configured\nto provide realtime timestamps, the REAL_TIME_CLOCK_ENABLE NV settings parameter\nshould be configured to TRUE, for example with command (and with following\nFW/driver reset):\n\n sudo mlxconfig -d /dev/mst/mt4125_pciconf0 s REAL_TIME_CLOCK_ENABLE=1\n\n\n3. Run DPDK application to gather the traces\n\nEAL parameters controlling trace capability in runtime\n\n --trace=pmd.net.mlx5.tx - the regular expression enabling the tracepoints\n with matching names at least \"pmd.net.mlx5.tx\"\n must be enabled to gather all events needed\n to analyze mlx5 Tx datapath and its timings.\n By default all tracepoints are disabled.\n\n --trace-dir=/var/log - trace storing directory\n\n --trace-bufsz=<val>B|<val>K|<val>M - optional, trace data buffer size\n per thread. The default is 1MB.\n\n --trace-mode=overwrite|discard - optional, selects trace data buffer mode.\n\n\n4. Installing or Building Babeltrace2 Package\n\nThe gathered trace data can be analyzed with a developed Python script.\nTo parse the trace, the data script uses the Babeltrace2 library.\nThe package should be either installed or built from source code as\nshown below:\n\n git clone https://github.com/efficios/babeltrace.git\n cd babeltrace\n ./bootstrap\n ./configure -help\n ./configure --disable-api-doc --disable-man-pages\n --disable-python-bindings-doc --enbale-python-plugins\n --enable-python-binding\n\n5. Running the Analyzing Script\n\nThe analyzing script is located in the folder: ./drivers/net/mlx5/tools\nIt requires Python3.6, Babeltrace2 packages and it takes the only parameter\nof trace data file. For example:\n\n ./mlx5_trace.py /var/log/rte-2023-01-23-AM-11-52-39\n\n\n6. Interpreting the Script Output Data\n\nAll the timings are given in nanoseconds.\nThe list of Tx (and coming Rx) bursts per port/queue is presented in the output.\nEach list element contains the list of built WQEs with specific opcodes, and\neach WQE contains the list of the encompassed packets to send.\n\nSigned-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>\n\n--\nv2: - comment addressed: \"dump_trace\" command is replaced with \"save_trace\"\n - Windows build failure addressed, Windows does not support tracing\n\nViacheslav Ovsiienko (5):\n app/testpmd: add trace save command\n common/mlx5: introduce tracepoints for mlx5 drivers\n net/mlx5: add Tx datapath tracing\n net/mlx5: add comprehensive send completion trace\n net/mlx5: add Tx datapath trace analyzing script\n\n app/test-pmd/cmdline.c | 38 ++++\n drivers/common/mlx5/meson.build | 1 +\n drivers/common/mlx5/mlx5_trace.c | 25 +++\n drivers/common/mlx5/mlx5_trace.h | 72 +++++++\n drivers/common/mlx5/version.map | 8 +\n drivers/net/mlx5/linux/mlx5_verbs.c | 8 +-\n drivers/net/mlx5/mlx5_devx.c | 8 +-\n drivers/net/mlx5/mlx5_rx.h | 19 --\n drivers/net/mlx5/mlx5_rxtx.h | 19 ++\n drivers/net/mlx5/mlx5_tx.c | 9 +\n drivers/net/mlx5/mlx5_tx.h | 88 ++++++++-\n drivers/net/mlx5/tools/mlx5_trace.py | 271 +++++++++++++++++++++++++++\n 12 files changed, 537 insertions(+), 29 deletions(-)\n create mode 100644 drivers/common/mlx5/mlx5_trace.c\n create mode 100644 drivers/common/mlx5/mlx5_trace.h\n create mode 100755 drivers/net/mlx5/tools/mlx5_trace.py" }