From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH 2/6] docs: update spp_pcap commands
Date: Fri, 15 Feb 2019 02:26:56 +0900 [thread overview]
Message-ID: <20190214172700.5816-3-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20190214172700.5816-1-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
* Update old example of `status` command.
* Add descriptions for worker threads and its status.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
docs/guides/commands/secondary/spp_pcap.rst | 109 ++++++++++++--------
1 file changed, 68 insertions(+), 41 deletions(-)
diff --git a/docs/guides/commands/secondary/spp_pcap.rst b/docs/guides/commands/secondary/spp_pcap.rst
index 33882f0..b7f04de 100644
--- a/docs/guides/commands/secondary/spp_pcap.rst
+++ b/docs/guides/commands/secondary/spp_pcap.rst
@@ -1,6 +1,7 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2014 Intel Corporation
+
.. _commands_spp_pcap:
spp_pcap
@@ -21,7 +22,7 @@ processes including ``spp_nfv``, ``spp_vm`` and others.
and sub command should be separated with delimiter ``;``, or failed to a
command error.
-.. code-block:: console
+.. code-block:: none
spp > pcap SEC_ID; SUB_CMD
@@ -29,23 +30,23 @@ In this example, ``SEC_ID`` is a secondary ID and ``SUB_CMD`` is one of the
following sub commands. Details of each of sub commands are described in the
next sections.
-* exit
-* start
* status
+* start
* stop
+* exit
``spp_pcap`` supports TAB completion. You can complete all of the name
of commands and its arguments. For instance, you find all of sub commands
by pressing TAB after ``pcap SEC_ID;``.
-.. code-block:: console
+.. code-block:: none
spp > pcap 1; # press TAB key
exit start status stop
It tries to complete all of possible arguments.
-.. code-block:: console
+.. code-block:: none
spp > pcap 1; component st # press TAB key to show args starting 'st'
start status stop
@@ -54,14 +55,15 @@ If you are reached to the end of arguments, no candidate keyword is displayed.
It is a completed statement of ``start`` command, and TAB
completion does not work after ``start`` because it is ready to run.
-.. code-block:: console
+.. code-block:: none
spp > pcap 1; start
Succeeded to start capture
-It is also completed secondary IDs of ``spp_pcap`` and it is helpful if you run several ``spp_pcap`` processes.
+It is also completed secondary IDs of ``spp_pcap`` and it is helpful if you
+run several ``spp_pcap`` processes.
-.. code-block:: console
+.. code-block:: none
spp > pcap # press TAB after space following 'pcap'
1; 3; # you find two spp_pcap processes of sec ID 1, 3
@@ -70,7 +72,7 @@ By the way, it is also a case of no candidate keyword is displayed if your
command statement is wrong. You might be encountered an error if you run the
wrong command. Please take care.
-.. code-block:: console
+.. code-block:: none
spp > pcap 1; ste # no candidate shown for wrong command
Invalid command "ste".
@@ -81,70 +83,95 @@ wrong command. Please take care.
status
------
-Show the information of worker threads and its resources. Status information
-consists of three parts.
+Show the information of worker threads of ``receiver`` and ``writer`` threads
+and its resources.
-.. code-block:: console
+.. code-block:: none
spp > pcap 1; status
- Basic Information:
- - client-id: 3
+ - client-id: 1
+ - status: idling
+ - core:2 receive
+ - rx: phy:0
+ - core:3 write
+ - filename:
+ - core:4 write
+ - filename:
+ - core:5 write
+ - filename:
+ - core:6 write
+ - filename:
+
+``client-id`` is a secondary ID of the process and ``status`` shows
+running status.
+
+Each of lcore has a role of ``receive`` or ``write``.
+``receiver`` has capture port as input and ``write`` has a capture file
+as output, but the ``filename`` is empty while ``idling`` status
+because capturing is not started yet.
+
+If you start capturing, you can find each of ``writer`` threads has a
+capture file. After capturing is stopped, ``filename`` is returned to
+be empty again.
+
+.. code-block:: none
+
+ spp > pcap 2; status
+ - client-id: 2
- status: running
- - core:2 'receive'
+ - core:2 receive
- rx: phy:0
- - core:3 'write'
- - file:/tmp/spp_pcap.20181108110600.phy0.1.1.pcap
- - core:4 'write'
- - file:/tmp/spp_pcap.20181108110600.phy0.2.1.pcap
- - core:5 'write'
- - file:/tmp/spp_pcap.20181108110600.phy0.3.1.pcap
-
-``Basic Information`` is for describing attributes of ``spp_pcap`` itself.
-``client-id`` is a secondary ID of the process and ``status`` shows the
-status of the process.
-
-Then lists of core IDs and its role is shown. There are two types of the role
-``receive`` and ``write``. If the role is ``receive``, port which ``spp_pcap``
-is attached to is shown. Else if the role iw ``write``, file name in absolute
-path is shown.
+ - core:3 write
+ - filename: /tmp/spp_pcap.20190214161550.phy0.1.1.pcap.lz4
+ - core:4 write
+ - filename: /tmp/spp_pcap.20190214161550.phy0.2.1.pcap.lz4
+ - core:5 write
+ - filename: /tmp/spp_pcap.20190214161550.phy0.3.1.pcap.lz4
+ - core:6 write
+ - filename: /tmp/spp_pcap.20190214161550.phy0.4.1.pcap.lz4
+
.. _commands_spp_pcap_start:
start
-----
-Start packet capture. No additional arguments are taken.
+Start packet capture.
-.. code-block:: console
+.. code-block:: none
# start capture
spp > pcap SEC_ID; start
-Here is a example of starting capture with ``start`` command.
+Here is a example of starting capture.
-.. code-block:: console
+.. code-block:: none
# start capture
- spp > pcap 2; start
+ spp > pcap 1; start
+ Start packet capture.
+
.. _commands_spp_pcap_stop:
stop
----
-Stop packet capture. No additional arguments are taken.
+Stop packet capture.
-.. code-block:: console
+.. code-block:: none
- # start capture
+ # stop capture
spp > pcap SEC_ID; stop
-Here is a example of stopping capture with ``stop`` command.
+Here is a example of stopping capture.
-.. code-block:: console
+.. code-block:: none
# stop capture
spp > pcap 2; stop
+ Start packet capture.
+
.. _commands_spp_pcap_exit:
@@ -153,6 +180,6 @@ exit
Terminate the ``spp_pcap``.
-.. code-block:: console
+.. code-block:: none
spp > pcap 1; exit
--
2.17.1
next prev parent reply other threads:[~2019-02-14 17:27 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-14 17:26 [spp] [PATCH 0/6] Update docs of spp_pcap ogawa.yasufumi
2019-02-14 17:26 ` [spp] [PATCH 1/6] docs: update design and howto use " ogawa.yasufumi
2019-02-14 17:26 ` ogawa.yasufumi [this message]
2019-02-14 17:26 ` [spp] [PATCH 3/6] docs: move images " ogawa.yasufumi
2019-02-14 17:26 ` [spp] [PATCH 4/6] docs: update overview image " ogawa.yasufumi
2019-02-14 17:26 ` [spp] [PATCH 5/6] docs: rename files of usecases in spp_vf ogawa.yasufumi
2019-02-14 17:27 ` [spp] [PATCH 6/6] docs: update usecase of spp_pcap ogawa.yasufumi
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=20190214172700.5816-3-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
/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).