From: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
To: <dev@dpdk.org>
Cc: <jerinj@marvell.com>, <rasland@nvidia.com>
Subject: [PATCH v6 2/2] doc: add mlx5 datapath tracing feature description
Date: Tue, 11 Jul 2023 18:15:21 +0300 [thread overview]
Message-ID: <20230711151521.30175-3-viacheslavo@nvidia.com> (raw)
In-Reply-To: <20230711151521.30175-1-viacheslavo@nvidia.com>
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).
The patch adds the documentation for feature usage.
Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
doc/guides/nics/mlx5.rst | 74 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 74 insertions(+)
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 505873ecfd..a407920555 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1923,6 +1923,80 @@ The procedure below is an example of using a ConnectX-5 adapter card (pf0) with
$ echo "0000:82:00.2" >> /sys/bus/pci/drivers/mlx5_core/bind
+How to trace Tx datapath
+------------------------
+
+The mlx5 PMD provides Tx datapath tracing capability with extra debug information:
+when and how packets were scheduled
+and when the actual sending was completed by the NIC hardware.
+
+Steps to enable Tx datapath tracing:
+
+#. Build DPDK application with enabled datapath tracing
+
+ The Meson option ``--enable_trace_fp=true`` and
+ the C flag ``ALLOW_EXPERIMENTAL_API`` should be specified.
+
+ .. code-block:: console
+
+ meson configure --buildtype=debug -Denable_trace_fp=true
+ -Dc_args='-DRTE_LIBRTE_MLX5_DEBUG -DRTE_ENABLE_ASSERT -DALLOW_EXPERIMENTAL_API' build
+
+#. Configure the NIC
+
+ If the sending completion timings are important,
+ the NIC should be configured to provide realtime timestamps.
+ The non-volatile settings parameter ``REAL_TIME_CLOCK_ENABLE`` should be configured as one.
+ The ``mlxconfig`` utility is part of the MFT package.
+
+ .. code-block:: console
+
+ mlxconfig -d /dev/mst/mt4125_pciconf0 s REAL_TIME_CLOCK_ENABLE=1
+
+#. Run application with EAL parameter enabling the tracing in mlx5 Tx datapath
+
+ By default all tracepoints are disabled.
+ To analyze Tx datapath and its timings: ``--trace=pmd.net.mlx5.tx``.
+
+#. Commit the tracing data to the storage (with ``rte_trace_save()`` API call).
+
+#. Install or build the ``babeltrace2`` package
+
+ The Python script analyzing gathered trace data uses the ``babeltrace2`` library.
+ The package should be either installed or built from source as shown below.
+
+ .. code-block:: console
+
+ git clone https://github.com/efficios/babeltrace.git
+ cd babeltrace
+ ./bootstrap
+ ./configure -help
+ ./configure --disable-api-doc --disable-man-pages
+ --disable-python-bindings-doc --enable-python-plugins
+ --enable-python-binding
+
+#. Run analyzing script
+
+ ``mlx5_trace.py`` is used to combine related events (packet firing and completion)
+ and to show the results in human-readable view.
+
+ The analyzing script is located in the DPDK source tree: ``drivers/net/mlx5/tools``.
+
+ It requires Python 3.6, ``babeltrace2`` package.
+
+ The parameter of the script is the trace data folder.
+
+ .. code-block:: console
+
+ mlx5_trace.py /var/log/rte-2023-01-23-AM-11-52-39
+
+#. Interpreting the script output data
+
+ All the timings are given in nanoseconds.
+ The list of Tx bursts per port/queue is presented in the output.
+ Each list element contains the list of built WQEs with specific opcodes.
+ Each WQE contains the list of the encompassed packets to send.
+
Host shaper
-----------
--
2.18.1
next prev parent reply other threads:[~2023-07-11 15:16 UTC|newest]
Thread overview: 76+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-20 10:07 [RFC 0/5] net/mlx5: introduce Tx datapath tracing Viacheslav Ovsiienko
2023-04-20 10:07 ` [RFC 1/5] app/testpmd: add trace dump command Viacheslav Ovsiienko
2023-04-20 10:13 ` Jerin Jacob
2023-04-20 10:08 ` [RFC 2/5] common/mlx5: introduce tracepoints for mlx5 drivers Viacheslav Ovsiienko
2023-04-20 10:11 ` Jerin Jacob
2023-06-13 15:50 ` Slava Ovsiienko
2023-06-13 15:53 ` Jerin Jacob
2023-06-13 15:59 ` Slava Ovsiienko
2023-06-13 16:01 ` Jerin Jacob
2023-06-27 0:39 ` Thomas Monjalon
2023-06-27 6:15 ` Slava Ovsiienko
2023-06-27 7:28 ` Thomas Monjalon
2023-06-27 8:19 ` Slava Ovsiienko
2023-06-27 9:33 ` Thomas Monjalon
2023-06-27 9:43 ` Slava Ovsiienko
2023-06-27 11:36 ` Thomas Monjalon
2023-04-20 10:08 ` [RFC 3/5] net/mlx5: add Tx datapath tracing Viacheslav Ovsiienko
2023-04-20 10:08 ` [RFC 4/5] net/mlx5: add comprehensive send completion trace Viacheslav Ovsiienko
2023-04-20 10:08 ` [RFC 5/5] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-06-09 15:28 ` [PATCH 0/5] net/mlx5: introduce Tx datapath tracing Viacheslav Ovsiienko
2023-06-09 15:28 ` [PATCH 1/5] app/testpmd: add trace dump command Viacheslav Ovsiienko
2023-06-09 15:28 ` [PATCH 2/5] common/mlx5: introduce tracepoints for mlx5 drivers Viacheslav Ovsiienko
2023-06-09 15:28 ` [PATCH 3/5] net/mlx5: add Tx datapath tracing Viacheslav Ovsiienko
2023-06-09 15:28 ` [PATCH 4/5] net/mlx5: add comprehensive send completion trace Viacheslav Ovsiienko
2023-06-09 15:28 ` [PATCH 5/5] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-06-13 16:58 ` [PATCH v2 0/5] net/mlx5: introduce Tx datapath tracing Viacheslav Ovsiienko
2023-06-13 16:58 ` [PATCH v2 1/5] app/testpmd: add trace save command Viacheslav Ovsiienko
2023-06-21 11:15 ` Ferruh Yigit
2023-06-23 8:00 ` Slava Ovsiienko
2023-06-23 11:52 ` Ferruh Yigit
2023-06-23 12:03 ` Jerin Jacob
2023-06-23 12:14 ` Slava Ovsiienko
2023-06-23 12:23 ` Ferruh Yigit
2023-06-13 16:58 ` [PATCH v2 2/5] common/mlx5: introduce tracepoints for mlx5 drivers Viacheslav Ovsiienko
2023-06-13 16:58 ` [PATCH v2 3/5] net/mlx5: add Tx datapath tracing Viacheslav Ovsiienko
2023-06-13 16:58 ` [PATCH v2 4/5] net/mlx5: add comprehensive send completion trace Viacheslav Ovsiienko
2023-06-13 16:58 ` [PATCH v2 5/5] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-06-20 12:00 ` [PATCH v2 0/5] net/mlx5: introduce Tx datapath tracing Raslan Darawsheh
2023-06-27 0:46 ` Thomas Monjalon
2023-06-27 11:24 ` Slava Ovsiienko
2023-06-27 11:34 ` Thomas Monjalon
2023-06-28 14:18 ` Robin Jarry
2023-06-29 7:16 ` Slava Ovsiienko
2023-06-29 9:08 ` Robin Jarry
2023-06-26 11:06 ` [PATCH] app/testpmd: add trace dump command Viacheslav Ovsiienko
2023-06-26 11:07 ` [PATCH v3] " Viacheslav Ovsiienko
2023-06-26 11:57 ` [PATCH v4] " Viacheslav Ovsiienko
2023-06-27 11:34 ` Ferruh Yigit
2023-06-27 11:39 ` Slava Ovsiienko
2023-06-27 11:58 ` Ferruh Yigit
2023-06-27 14:44 ` [PATCH] app/testpmd: add dump command help message Viacheslav Ovsiienko
2023-06-27 18:03 ` Ferruh Yigit
2023-06-28 9:54 ` [PATCH v2] " Viacheslav Ovsiienko
2023-06-28 13:18 ` Ferruh Yigit
2023-06-27 13:09 ` [PATCH v5] app/testpmd: add trace dump command Viacheslav Ovsiienko
2023-06-27 15:18 ` Ferruh Yigit
2023-06-28 11:09 ` [PATCH v3 0/4] net/mlx5: introduce Tx datapath tracing Viacheslav Ovsiienko
2023-06-28 11:09 ` [PATCH v3 1/4] net/mlx5: introduce tracepoints for mlx5 drivers Viacheslav Ovsiienko
2023-06-28 11:09 ` [PATCH v3 2/4] net/mlx5: add comprehensive send completion trace Viacheslav Ovsiienko
2023-06-28 11:09 ` [PATCH v3 3/4] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-06-28 11:09 ` [PATCH v3 4/4] doc: add mlx5 datapath tracing feature description Viacheslav Ovsiienko
2023-07-05 11:10 ` [PATCH v4 0/4] net/mlx5: introduce Tx datapath tracing Viacheslav Ovsiienko
2023-07-05 11:10 ` [PATCH v4 1/4] net/mlx5: introduce tracepoints for mlx5 drivers Viacheslav Ovsiienko
2023-07-05 11:10 ` [PATCH v4 2/4] net/mlx5: add comprehensive send completion trace Viacheslav Ovsiienko
2023-07-05 11:10 ` [PATCH v4 3/4] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-07-05 11:10 ` [PATCH v4 4/4] doc: add mlx5 datapath tracing feature description Viacheslav Ovsiienko
2023-07-05 15:31 ` [PATCH v5 0/4] net/mlx5: introduce Tx datapath tracing Viacheslav Ovsiienko
2023-07-05 15:31 ` [PATCH v5 1/4] net/mlx5: introduce tracepoints for mlx5 drivers Viacheslav Ovsiienko
2023-07-05 15:31 ` [PATCH v5 2/4] net/mlx5: add comprehensive send completion trace Viacheslav Ovsiienko
2023-07-05 15:31 ` [PATCH v5 3/4] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-07-05 15:31 ` [PATCH v5 4/4] doc: add mlx5 datapath tracing feature description Viacheslav Ovsiienko
2023-07-06 16:27 ` [PATCH v5 0/4] net/mlx5: introduce Tx datapath tracing Raslan Darawsheh
2023-07-11 15:15 ` [PATCH v6 0/2] " Viacheslav Ovsiienko
2023-07-11 15:15 ` [PATCH v6 1/2] net/mlx5: add Tx datapath trace analyzing script Viacheslav Ovsiienko
2023-07-11 15:15 ` Viacheslav Ovsiienko [this message]
2023-07-27 10:52 ` [PATCH v6 0/2] net/mlx5: introduce Tx datapath tracing Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230711151521.30175-3-viacheslavo@nvidia.com \
--to=viacheslavo@nvidia.com \
--cc=dev@dpdk.org \
--cc=jerinj@marvell.com \
--cc=rasland@nvidia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).