From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail04.ics.ntt-tx.co.jp (mail05.ics.ntt-tx.co.jp [210.232.35.69]) by dpdk.org (Postfix) with ESMTP id 0B4A21B762 for ; Fri, 8 Feb 2019 06:00:56 +0100 (CET) Received: from gwchk03.silk.ntt-tx.co.jp (gwchk03.silk.ntt-tx.co.jp [10.107.0.111]) by mail04.ics.ntt-tx.co.jp (unknown) with ESMTP id x1850s6g019794; Fri, 8 Feb 2019 14:00:54 +0900 Received: (from root@localhost) by gwchk03.silk.ntt-tx.co.jp (unknown) id x1850rm0001974; Fri, 8 Feb 2019 14:00:53 +0900 Received: from gwchk.silk.ntt-tx.co.jp [10.107.0.110] by gwchk03.silk.ntt-tx.co.jp with ESMTP id PAA29938; Fri, 8 Feb 2019 13:51:45 +0900 Received: from imss04.silk.ntt-tx.co.jp (localhost [127.0.0.1]) by imss04.silk.ntt-tx.co.jp (unknown) with ESMTP id x184pi5k029835; Fri, 8 Feb 2019 13:51:44 +0900 Received: from mgate01.silk.ntt-tx.co.jp (smtp02.silk.ntt-tx.co.jp [10.107.0.37]) by imss04.silk.ntt-tx.co.jp (unknown) with ESMTP id x184pi5d029831; Fri, 8 Feb 2019 13:51:44 +0900 Message-Id: <201902080451.x184pi5d029831@imss04.silk.ntt-tx.co.jp> Received: from localhost by mgate01.silk.ntt-tx.co.jp (unknown) id x184piUH011193 ; Fri, 8 Feb 2019 13:51:44 +0900 From: x-fn-spp@sl.ntt-tx.co.jp To: ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Cc: spp@dpdk.org Date: Fri, 8 Feb 2019 13:51:44 +0900 X-Mailer: git-send-email 2.18.0 X-TM-AS-MML: No Subject: [spp] [PATCH 1/1] docs: add core sharing usage in spp_vf command ref X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 08 Feb 2019 05:00:57 -0000 From: Hideyuki Yamashita This patch adds how to assign more than one component on the same core in component command of spp_vf into command reference. This patch also fixes typos. Signed-off-by: Hideyuki Yamashita Signed-off-by: Naoki Takada --- docs/guides/commands/secondary/spp_vf.rst | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/docs/guides/commands/secondary/spp_vf.rst b/docs/guides/commands/secondary/spp_vf.rst index 3cf1cca..6f1824b 100644 --- a/docs/guides/commands/secondary/spp_vf.rst +++ b/docs/guides/commands/secondary/spp_vf.rst @@ -6,7 +6,7 @@ spp_vf ====== -``spp_vf`` is a kind of SPP secondary process. It it introduced for +``spp_vf`` is a kind of SPP secondary process. It is introduced for providing SR-IOV like features. Each of ``spp_vf`` processes is managed with ``vf`` command. It is for @@ -136,7 +136,7 @@ assigned to this thread. ``Components`` is a list of all of worker threads. Each of workers has a core ID running on, type of the worker and a list of resources. Entry of no name with ``unuse`` type means that no worker thread assigned to -the core. In other words, it is ready to be assinged. +the core. In other words, it is ready to be assigned. .. _commands_spp_vf_component: @@ -144,7 +144,7 @@ the core. In other words, it is ready to be assinged. component --------- -Assing or release a role of forwarding to worker threads running on each of +Assign or release a role of forwarding to worker threads running on each of cores which are reserved with ``-c`` or ``-l`` option while launching ``spp_vf``. The role of the worker is chosen from ``forward``, ``merge`` or ``classifier_mac``. @@ -165,7 +165,7 @@ This name is also used while releasing the role. # release worker 'NAME' from the role spp > vf SEC_ID; component stop NAME -Here is some examples of assigning roles with ``component`` command. +Here are some examples of assigning roles with ``component`` command. .. code-block:: console @@ -178,7 +178,18 @@ Here is some examples of assigning roles with ``component`` command. # assign 'classifier_mac' role with name 'cls1' on core 4 spp > vf 2; component start cls1 4 classifier_mac -Or examples of releasing roles. +In the above examples, each different ``CORE-ID`` is specified to each role. +You can assign several components on the same core, but performance might be +decreased. This is an example for assigning two roles of ``forward`` and +``merge`` on the same ``core 2``. + +.. code-block:: console + + # assign two roles on the same 'core 2'. + spp > vf 2; component start fw1 2 forward + spp > vf 2; component start mgr1 2 merge + +Examples of releasing roles. .. code-block:: console @@ -340,7 +351,7 @@ Here is an example for adding entries. # add entry of default with VLAN tag spp > vf 1; classifier_table add vlan 101 default ring:1 -Delete an entryThis is an example to delete an entry for port ``ring:0``. +Delete an entry. This is an example to delete an entry with VLAN tag 101. .. code-block:: console -- 2.17.1