From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH v2 5/8] docs: update Getting Started section of sppc
Date: Fri, 14 Dec 2018 08:04:00 +0900 [thread overview]
Message-ID: <1544742243-32554-6-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <1544742243-32554-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Update descriptions and examples to the latest release.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
docs/guides/tools/sppc/getting_started.rst | 51 ++++++++++++++++++------------
1 file changed, 30 insertions(+), 21 deletions(-)
diff --git a/docs/guides/tools/sppc/getting_started.rst b/docs/guides/tools/sppc/getting_started.rst
index 8a6b5b8..0ae0978 100644
--- a/docs/guides/tools/sppc/getting_started.rst
+++ b/docs/guides/tools/sppc/getting_started.rst
@@ -142,15 +142,14 @@ It is better to define this variable in ``$HOME/.bashrc``.
.. code-block:: console
# Set your host IP address
- export SPP_CTRL_IP=[HOST_IPADDR]
+ export SPP_CTRL_IP=HOST_IPADDR
SPP Controller
~~~~~~~~~~~~~~
-Launch SPP controller to be ready
-before primary and secondary processes.
-SPP controller is launched in the terminal 1 in this guide.
+Launch ``spp-ctl`` and ``spp.py`` to be ready before primary and secondary
+processes.
.. note::
@@ -161,10 +160,20 @@ SPP controller is launched in the terminal 1 in this guide.
``mlterm`` is the most useful and easy to customize.
Refer :doc:`../../commands/experimental` for ``topo`` command.
+``spp-ctl`` is launched in the termina l.
+
.. code-block:: console
# Terminal 1
$ cd /path/to/spp
+ $ python3 src/spp-ctl/spp-ctl
+
+``spp.py`` is launched in the terminal 2.
+
+.. code-block:: console
+
+ # Terminal 2
+ $ cd /path/to/spp
$ python src/spp.py
@@ -173,13 +182,13 @@ SPP Primary Container
As ``SPP_CTRL_IP`` is activated, you are enalbed to run
``app/spp-primary.py`` with options of EAL and SPP primary
-in terminal 2.
+in terminal 3.
In this case, launch spp-primary in background mode using one core
and two ports.
.. code-block:: console
- # Terminal 2
+ # Terminal 3
$ cd /path/to/spp/tools/sppc
$ python app/spp-primary.py -l 0 -p 0x03
@@ -194,13 +203,13 @@ There behave as similar to ``spp_nfv`` running on host and
The difference is that both of them are running on containers.
You use only ``spp_nfv.py`` in this guide.
-Launch ``spp_nfv`` in terminal 2
+Launch ``spp_nfv`` in terminal 3
with options for secondary ID is ``1`` and
core list is ``1-2`` for using 2nd and 3rd cores.
.. code-block:: console
- # Terminal 2
+ # Terminal 3
$ python app/spp-nfv.py -i 1 -l 1-2
If it is succeeded, container is running in background.
@@ -218,9 +227,9 @@ before launching the app container.
.. code-block:: console
- # Terminal 1
- spp > sec 1;add vhost 1
- spp > sec 1;add vhost 2
+ # Terminal 2
+ spp > nfv 1; add vhost 1
+ spp > nfv 1; add vhost 2
``spp_nfv`` of ID 1 running inside container creates
``vhost:1`` and ``vhost:2``.
@@ -229,7 +238,7 @@ app container launcher.
.. code-block:: console
- # Terminal 2
+ # Terminal 3
$ cd /path/to/spp/tools/sppc
$ app/testpmd.py -l 3-4 -d 1,2
sudo docker run -it \
@@ -272,17 +281,17 @@ and start forwarding from testpmd.
SPP and testpmd on containers
-From terminal 1, add ``ring:0``, connect ``vhost:1`` and ``vhost:2``
+In terminal 2, add ``ring:0``, connect ``vhost:1`` and ``vhost:2``
with it.
.. code-block:: console
- # Terminal 1
- spp > sec 1;add ring 0
- spp > sec 1;patch vhost:1 ring:0
- spp > sec 1;patch ring:0 vhost:2
- spp > sec 1;forward
- spp > sec 1;status
+ # Terminal 2
+ spp > nfv 1; add ring 0
+ spp > nfv 1; patch vhost:1 ring:0
+ spp > nfv 1; patch ring:0 vhost:2
+ spp > nfv 1; forward
+ spp > nfv 1; status
status: running
ports:
- 'ring:0 -> vhost:2'
@@ -293,7 +302,7 @@ Start forwarding on port 0 by ``start tx_first``.
.. code-block:: console
- # Terminal 2
+ # Terminal 3
testpmd> start tx_first
io packet forwarding - ports=2 - cores=1 - streams=2 - NUMA support...
Logical Core 4 (socket 0) forwards packets on 2 streams:
@@ -306,7 +315,7 @@ In this case, about 35 million packets are forwarded.
.. code-block:: console
- # Terminal 2
+ # Terminal 3
testpmd> stop
Telling cores to stop...
Waiting for lcores to finish...
--
2.7.4
next prev parent reply other threads:[~2018-12-13 23:06 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-12 2:03 [spp] [PATCH 0/7] Revise documentation for the latest release ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 1/7] docs: update Getting Started section ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 2/7] docs: update How to Use section ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 3/7] docs: update Use Cases section ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 4/7] docs: update spp_nfv commands ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 5/7] docs: update Getting Started section of sppc ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 6/7] docs: update Use Cases " ogawa.yasufumi
2018-12-12 2:03 ` [spp] [PATCH 7/7] recipes: update recipe files ogawa.yasufumi
2018-12-13 23:03 ` [spp] [PATCH v2 0/8] Revise documentation for the latest release ogawa.yasufumi
2018-12-13 23:03 ` [spp] [PATCH v2 1/8] docs: update Getting Started section ogawa.yasufumi
2018-12-13 23:03 ` [spp] [PATCH v2 2/8] docs: update How to Use section ogawa.yasufumi
2018-12-13 23:03 ` [spp] [PATCH v2 3/8] docs: update Use Cases section ogawa.yasufumi
2018-12-13 23:03 ` [spp] [PATCH v2 4/8] docs: update spp_nfv commands ogawa.yasufumi
2018-12-13 23:04 ` ogawa.yasufumi [this message]
2018-12-13 23:04 ` [spp] [PATCH v2 6/8] docs: update Use Cases section of sppc ogawa.yasufumi
2018-12-13 23:04 ` [spp] [PATCH v2 7/8] recipes: update recipe files ogawa.yasufumi
2018-12-13 23:04 ` [spp] [PATCH v2 8/8] docs: revise how to use section of spp_vf 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=1544742243-32554-6-git-send-email-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).