summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>2019-02-12 21:39:27 +0900
committerYasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>2019-02-13 17:10:27 +0900
commitd500a4723d68445d4f672d897dd81cd48e3e1ee7 (patch)
tree58173d1e0161ef27283e995768335de1bacaf62a
parent370f701a63a1587ac1e7557751af356b47c716ac (diff)
downloadspp-d500a4723d68445d4f672d897dd81cd48e3e1ee7.zip
spp-d500a4723d68445d4f672d897dd81cd48e3e1ee7.tar.gz
spp-d500a4723d68445d4f672d897dd81cd48e3e1ee7.tar.xz
docs: add decs of behaviour of spp_vf siblings
This update is to add descriptions of behaviour of spp_vf and its siblings to start forwarding immediately without request from user if required number of ports are added to. Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp> Acked-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
-rw-r--r--docs/guides/commands/secondary/spp_mirror.rst13
-rw-r--r--docs/guides/commands/secondary/spp_vf.rst18
-rw-r--r--docs/guides/spp_vf/design.rst10
3 files changed, 39 insertions, 2 deletions
diff --git a/docs/guides/commands/secondary/spp_mirror.rst b/docs/guides/commands/secondary/spp_mirror.rst
index f81d3a9..bb60f05 100644
--- a/docs/guides/commands/secondary/spp_mirror.rst
+++ b/docs/guides/commands/secondary/spp_mirror.rst
@@ -198,6 +198,13 @@ by duplicating the packets.
spp > mirror 2; port add vhost:0 tx mr1
spp > mirror 2; port add vhost:1 tx mr1
+Adding port may cause component to start packet forwarding. Please see
+detail in
+:ref:`design spp_mirror<spp_vf_design_spp_mirror>`.
+
+Until one rx and two tx ports are registered, ``spp_mirror`` does not start
+forwarding. If it is requested to add more than one rx and two tx ports, it
+replies an error message.
Deleting port
~~~~~~~~~~~~~
@@ -219,6 +226,12 @@ Here is some examples.
# delete tx port 'vhost:1' from 'mr1'
spp > mirror 2; port del vhost:1 tx mr1
+
+.. note::
+
+ Deleting port may cause component to stop packet forwarding.
+ Please see detail in :ref:`design spp_mirror<spp_vf_design_spp_mirror>`.
+
exit
----
diff --git a/docs/guides/commands/secondary/spp_vf.rst b/docs/guides/commands/secondary/spp_vf.rst
index 6f1824b..d31688e 100644
--- a/docs/guides/commands/secondary/spp_vf.rst
+++ b/docs/guides/commands/secondary/spp_vf.rst
@@ -276,6 +276,20 @@ adds VLAN tag before sending packet outside.
# add VLAN tag with VLAN ID and PCP in forwarder 'fw2'
spp > vf 2; port add phy:1 tx fw2 add_vlantag 101 3
+Adding port may cause component to start packet forwarding. Please see
+detail in
+:ref:`design spp_vf<spp_vf_design_spp_vf>`.
+
+Until one rx port and one tx port are added, forwarder does not start packet
+forwarding. If it is requested to add more than one rx and one tx port, it
+replies an error message.
+Until at least one rx port and two tx ports are added, classifier does not
+start packet forwarding. If it is requested to add more than two rx ports, it
+replies an error message.
+Until at least two rx ports and one tx port are added, merger does not start
+packet forwarding. If it is requested to add more than two tx ports, it replies
+an error message.
+
Deleting port
~~~~~~~~~~~~~
@@ -298,6 +312,10 @@ Here is an example.
# delete tx port 'vhost:1' from 'mgr1'
spp > vf 2; port del vhost:1 tx mgr1
+.. note::
+
+ Deleting port may cause component to stop packet forwarding.
+ Please see detail in :ref:`design spp_vf<spp_vf_design_spp_vf>`.
.. _commands_spp_vf_classifier_table:
diff --git a/docs/guides/spp_vf/design.rst b/docs/guides/spp_vf/design.rst
index 23246ba..4774ef7 100644
--- a/docs/guides/spp_vf/design.rst
+++ b/docs/guides/spp_vf/design.rst
@@ -1,5 +1,5 @@
.. SPDX-License-Identifier: BSD-3-Clause
- Copyright(c) 2019 Nippon Telegraph and Telephone Corporation
+ Copyright(c) 2010-2014 Intel Corporation
.. _spp_vf_design:
@@ -37,12 +37,16 @@ Forwarder
^^^^^^^^^
Simply forwards packets from rx to tx port.
+Forwarder does not start forwarding until when at least one rx and one tx are
+added.
Merger
^^^^^^
Receives packets from multiple rx ports to aggregate
packets and sends to a desctination port.
+Merger does not start forwarding until when at least two rx and one tx are
+added.
Classifier
^^^^^^^^^^
@@ -56,6 +60,8 @@ Classifier prepares tables for each of VLAN ID and decides
which of table is referred
if TPID (Tag Protocol Indetifier) is included in a packet and
equals to 0x8100 as defined in IEEE 802.1Q standard.
+Classifier does not start forwarding until when at least one rx and two tx are
+added.
.. _spp_vf_design_spp_mirror:
@@ -107,7 +113,7 @@ spp_pcap
the second smallest ID and ``wirter`` threads on the rest of cores. You should
have enough cores if you need to capture large amount of packets.
-``spp_pcap`` has 4 types of command. ``start``,``stop``,``exit`` and ``status``
+``spp_pcap`` has 4 types of command. ``start``, ``stop``, ``exit`` and ``status``
to control behavior of ``spp_pcap``.
With ``start`` command, you can start capturing.