Skip to contentSkip to conversation

doc: update pdump documentation

PATCH Superseded Reshma Pattan 3 participants 6 messages Jul 13, 2020 – Nov 26, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: update pdump documentation

Update the pdump library programmers guide and Howto doc with the use of multi process channel replacing socket based communication.

---
 doc/guides/howto/packet_capture_framework.rst | 16 ++++-----
 doc/guides/prog_guide/pdump_lib.rst           | 49 +++++++++++----------------
 2 files changed, 28 insertions(+), 37 deletions(-)
doc/guides/howto/packet_capture_framework.rst +8 -8
index 946a21c..c941c01 100644
@@ -19,7 +19,7 @@ Introduction
 
 The :ref:`librte_pdump <pdump_library>` library provides the APIs required to
 allow users to initialize the packet capture framework and to enable or
-disable packet capture. The library works on a client/server model and its
+disable packet capture. The library works on a multi process communication model and its
 usage is recommended for debugging purposes.
 
 The :ref:`dpdk-pdump <pdump_tool>` tool is developed based on the
@@ -28,14 +28,14 @@ of enabling or disabling packet capture on DPDK ports. The ``dpdk-pdump`` tool
 provides command-line options with which users can request enabling or
 disabling of the packet capture on DPDK ports.
 
-The application which initializes the packet capture framework will act as a
-server and the application that enables or disables the packet capture will
-act as a client. The server sends the Rx and Tx packets from the DPDK ports
-to the client.
+The application which initializes the packet capture framework will be a primary process
+and the application that enables or disables the packet capture will
+be a secondary process. The primary process sends the Rx and Tx packets from the DPDK ports
+to the secondary process.
 
-In DPDK the ``testpmd`` application can be used to initialize the packet
-capture framework and act as a server, and the ``dpdk-pdump`` tool acts as a
-client. To view Rx or Tx packets of ``testpmd``, the application should be
+In DPDK the ``testpmd`` application has been initialize with the packet
+capture framework and acts as primary process, and the ``dpdk-pdump`` tool acts as a
+secondary process. To view Rx or Tx packets of ``testpmd``, the application should be
 launched first, and then the ``dpdk-pdump`` tool. Packets from ``testpmd``
 will be sent to the tool, which then sends them on to the Pcap PMD device and
 that device writes them to the Pcap file or to an external interface depending
doc/guides/prog_guide/pdump_lib.rst +20 -29

70 lines not on this page · raw message

Signature · 1 line
1.8.3.1
#1 lore raw
Quoted 9 lines

-----Original Message-----
From: Pattan, Reshma <[email protected]>
Sent: Monday, July 13, 2020 3:25 PM
To: [email protected]
Cc: Pattan, Reshma <[email protected]>
Subject: [PATCH] doc: update pdump documentation

Quoted 5 lines

Update the pdump library programmers guide and Howto doc with the use of multi process channel replacing socket based communication.

---

Gentle remainder for review and ack on this .

#2 lore raw
Quoted 8 lines

-----Original Message-----
From: dev <[email protected]> On Behalf Of Pattan, Reshma

Quoted 2 lines

-----Original Message-----
From: Pattan, Reshma <[email protected]>

Gentle remainder for review and ack on this .

Gentle remainder to ack and apply

Acked-by on v1 1/1
#3 lore raw
In reply to Reshma Pattan
Quoted 6 lines · Reshma Pattan

Update the pdump library programmers guide and Howto doc with the use of multi process channel replacing socket based communication.

---

Some minor adjustments I'd suggest below. Otherwise:

Quoted 10 lines
 doc/guides/howto/packet_capture_framework.rst | 16 ++++-----
 doc/guides/prog_guide/pdump_lib.rst           | 49 +++++++++++----------------
 2 files changed, 28 insertions(+), 37 deletions(-)
doc/guides/howto/packet_capture_framework.rst +0 -0
index 946a21c..c941c01 100644
@@ -19,7 +19,7 @@ Introduction
 

<snip>

doc/guides/howto/packet_capture_framework.rst of enabling or disabling packet capture on DPDK ports. The ``dpdk-pdump`` tool · line 38

Quoted 6 lines
doc/guides/howto/packet_capture_framework.rst +3 -3
-In DPDK the ``testpmd`` application can be used to initialize the packet
-capture framework and act as a server, and the ``dpdk-pdump`` tool acts as a
-client. To view Rx or Tx packets of ``testpmd``, the application should be
+In DPDK the ``testpmd`` application has been initialize with the packet
+capture framework and acts as primary process, and the ``dpdk-pdump`` tool acts as a
+secondary process. To view Rx or Tx packets of ``testpmd``, the application should be

I think the original text was better for this block.

doc/guides/prog_guide/pdump_lib.rst The library does the complete copy of the Rx and Tx mbufs to a new mempool and · line 14

Quoted 12 lines

launched first, and then the ``dpdk-pdump`` tool. Packets from ``testpmd`` will be sent to the tool, which then sends them on to the Pcap PMD device and that device writes them to the Pcap file or to an external interface depending

doc/guides/prog_guide/pdump_lib.rst +1 -0
index 2a0f1f3..227eb1a 100644
@@ -11,8 +11,12 @@ The library does the complete copy of the Rx and Tx mbufs to a new mempool and
 hence it slows down the performance of the applications, so it is recommended
 to use this library for debugging purposes.
 
+The library uses generic multi process channel to facilitate communication
                 ^^a

Missing word "a" in sentence.

Quoted 3 lines
doc/guides/prog_guide/pdump_lib.rst +3 -0
+between primary and secondary process for enabling/disabling packet capture on
+ports.
+

<snip>

doc/guides/prog_guide/pdump_lib.rst or disable the packet capture, and to uninitialize it: · line 66

Quoted 8 lines

The library APIs ``rte_pdump_disable()`` and ``rte_pdump_disable_by_deviceid()`` disables the packet capture.

doc/guides/prog_guide/pdump_lib.rst +2 -5
-On each call to these APIs, the library creates a separate client socket, creates the "pdump disable" request and sends
-the request to the server. The server that is listening on the socket will take the request and disable the packet
-capture by removing the Ethernet RX and TX callbacks for the given port or device_id and queue combinations. The server
-also sends the response back to the client about the status of the request that was processed. After the response is
-received from the server, the client socket is closed.
+For the calls to these APIs from secondary process, the library creates the "pdump disable" request and sends
+the request to the primary process over the multi process channel, the primary process takes this request and disable

^^. ^^disables

Split sentence as indicated and also add "s" to disable.

Quoted 7 lines

+the packet capture by removing the Ethernet RX and TX callbacks for the given port or device_id and queue combinations.

The library API ``rte_pdump_uninit()``, uninitializes the packet capture framework by calling ``rte_mp_action_unregister()`` function.

Signature · 1 line
1.8.3.1
#4 lore raw

PATCH v2 1/1 doc: update pdump documentation

In reply to Reshma Pattan

Update the pdump library programmers guide and Howto doc with the use of multi process channel replacing socket based communication.

---
v2: fixes for the review comments

---
 doc/guides/howto/packet_capture_framework.rst | 12 +++----
 doc/guides/prog_guide/pdump_lib.rst           | 48 +++++++++++----------------
 2 files changed, 25 insertions(+), 35 deletions(-)
doc/guides/howto/packet_capture_framework.rst +6 -6
index 6bd51f6..c31bac5 100644
@@ -19,7 +19,7 @@ Introduction
 
 The :ref:`librte_pdump <pdump_library>` library provides the APIs required to
 allow users to initialize the packet capture framework and to enable or
-disable packet capture. The library works on a client/server model and its
+disable packet capture. The library works on a multi process communication model and its
 usage is recommended for debugging purposes.
 
 The :ref:`dpdk-pdump <pdump_tool>` tool is developed based on the
@@ -28,13 +28,13 @@ of enabling or disabling packet capture on DPDK ports. The ``dpdk-pdump`` tool
 provides command-line options with which users can request enabling or
 disabling of the packet capture on DPDK ports.
 
-The application which initializes the packet capture framework will act as a
-server and the application that enables or disables the packet capture will
-act as a client. The server sends the Rx and Tx packets from the DPDK ports
-to the client.
+The application which initializes the packet capture framework will be a primary process
+and the application that enables or disables the packet capture will
+be a secondary process. The primary process sends the Rx and Tx packets from the DPDK ports
+to the secondary process.
 
 In DPDK the ``testpmd`` application can be used to initialize the packet
-capture framework and act as a server, and the ``dpdk-pdump`` tool acts as a
+capture framework and acts as a server, and the ``dpdk-pdump`` tool acts as a
 client. To view Rx or Tx packets of ``testpmd``, the application should be
 launched first, and then the ``dpdk-pdump`` tool. Packets from ``testpmd``
 will be sent to the tool, which then sends them on to the Pcap PMD device and
doc/guides/prog_guide/pdump_lib.rst +19 -29

69 lines not on this page · raw message

Signature · 1 line
1.8.3.1
#5 lore raw
Quoted 7 lines · Reshma Pattan

Update the pdump library programmers guide and Howto doc with the use of multi process channel replacing socket based communication.

[snip]

doc/guides/prog_guide/pdump_lib.rst or disable the packet capture, and to uninitialize it: · line 66

Quoted 8 lines

The library APIs ``rte_pdump_disable()`` and ``rte_pdump_disable_by_deviceid()`` disables the packet capture.

doc/guides/prog_guide/pdump_lib.rst +2 -5
-On each call to these APIs, the library creates a separate client socket, creates the "pdump disable" request and sends
-the request to the server. The server that is listening on the socket will take the request and disable the packet
-capture by removing the Ethernet RX and TX callbacks for the given port or device_id and queue combinations. The server
-also sends the response back to the client about the status of the request that was processed. After the response is
-received from the server, the client socket is closed.
+For the calls to these APIs from secondary process, the library creates the "pdump disable" request and sends
+the request to the primary process over the multi process channel. The primary process takes this request and disables the packet capture by removing the Ethernet RX and TX callbacks for the given port or device_id and queue combinations.

I split this long line to multiple ~100 characters lines like the rest of the document.

Applied, thanks.

Signature · 1 line
David Marchand