From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0534.ocn.ad.jp (mogw0534.ocn.ad.jp [118.23.178.176]) by dpdk.org (Postfix) with ESMTP id 7B47A1B8AD for ; Thu, 1 Feb 2018 05:04:53 +0100 (CET) Received: from mf-smf-ucb034c2 (mf-smf-ucb034c2.ocn.ad.jp [153.153.66.228]) by mogw0534.ocn.ad.jp (Postfix) with ESMTP id 64269348241; Thu, 1 Feb 2018 13:04:52 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb024 ([153.149.142.98]) by mf-smf-ucb034c2 with ESMTP id h67De7lQB5EUwh67IeuPHR; Thu, 01 Feb 2018 13:04:52 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.166]) by ntt.pod01.mv-mta-ucb024 with id 5G4s1x0013c2f7501G4swg; Thu, 01 Feb 2018 04:04:52 +0000 Received: from localhost.localdomain (sp1-66-99-86.msc.spmode.ne.jp [1.66.99.86]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Thu, 1 Feb 2018 13:04:51 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com Cc: Yasufumi Ogawa Date: Thu, 1 Feb 2018 13:04:51 +0900 Message-Id: <20180201040501.8004-5-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 05/15] docs: add secondary commands 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: Thu, 01 Feb 2018 04:04:54 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/common.rst | 36 ++++++++- docs/guides/commands/index.rst | 7 ++ docs/guides/commands/secondary.rst | 162 +++++++++++++++++++++++++++++++++++++ 3 files changed, 202 insertions(+), 3 deletions(-) create mode 100644 docs/guides/commands/secondary.rst diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst index 728e68f..dc5e8e4 100644 --- a/docs/guides/commands/common.rst +++ b/docs/guides/commands/common.rst @@ -35,8 +35,8 @@ Common Commands status ------ -Display number of connected primary and secondary application count -Also display connected secondary application client_id. +Show the number of connected primary and secondary processes. +It also show a list of secondary IDs .. code-block:: console @@ -51,14 +51,34 @@ Also display connected secondary application client_id. record ------ +Start recording user's input and create a history file for ``playback`` +commnad. +Recording is stopped by executing ``exit`` or ``playback`` command. + .. code-block:: console spp > record 2nfv_uni.config +.. note:: + + It is not supported to stop recording without ``exit`` or ``playback`` + command. + It is planned to support ``stop`` command for stopping record in + next relase. + playback -------- +Restore configuration from a config file. +Content of config file is just a series of SPP commnad. +You prepare a config file by using ``record`` command or editing a text +file by hand. + +It is recommended to use extension ``.config`` to be self-sxplanatory +as a config, although you can use any of extensions such as ``.txt`` or +``.log``. + .. code-block:: console spp> playback 2nfv_uni.config @@ -90,6 +110,7 @@ Second one is for all SPP processes other than controller. closing: closing:('127.0.0.1', 53620) + help ---- @@ -97,8 +118,17 @@ help ``help`` command is not implemented yet. -Displays brief help +Show brief help .. code-block:: console spp > help + + Documented commands (type help ): + ======================================== + bye help playback pri record sec status + + spp > help status + Display Soft Patch Panel Status + spp > help sec + Send command to secondary process diff --git a/docs/guides/commands/index.rst b/docs/guides/commands/index.rst index b084b1f..7526e68 100644 --- a/docs/guides/commands/index.rst +++ b/docs/guides/commands/index.rst @@ -31,6 +31,13 @@ SPP Commands ============ +SPP provides commands for managing primary, secondary processes and SPP +controller. + .. toctree:: :maxdepth: 2 :numbered: + + primary + secondary + common diff --git a/docs/guides/commands/secondary.rst b/docs/guides/commands/secondary.rst new file mode 100644 index 0000000..8186e5d --- /dev/null +++ b/docs/guides/commands/secondary.rst @@ -0,0 +1,162 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Secondary Commands +====================== + +Each of secondary processes is managed with ``sec`` command. +It is for sending sub commands to secondary with specific ID called +secondary ID. + +``sec`` command takes an secondary ID and a sub command. They must be +separated with delimiter ``;``. +Some of sub commands take additional arguments for speicfying resource +owned by secondary process. + +.. code-block:: console + + spp > sec [SEC_ID];[SUB_CMD] + + +status +------ + +Show running status and resources. + +.. code-block:: console + + spp > sec 1;status + recv:7:{Client ID 1 Idling + 1 + port id: 0,on,PHY,outport: none + port id: 1,on,PHY,outport: none + } + + +add +--- + +Add a PMD to the secondary with resource ID. + +Adding ring 0 by + +.. code-block:: console + + spp> sec 1;add ring 0 + recv:7:{addring0} + +Or adding vhost 0 by + +.. code-block:: console + + spp> sec 1;add vhost 0 + recv:7:{addvhost0} + + +patch +------ + +Create a path between two ports, source and destination ports. +Port ID is referred by status sub commnad. +This command just creates path and does not start forwarding. + +.. code-block:: console + + spp > sec 1;patch 0 2 + recv:7:{patch02} + + +forward +------- + +Start forwarding. + +.. code-block:: console + + spp > sec 1;forward + recv:7:{start forwarding} + +Running status is changed from ``Idling`` to ``Running`` by +executing it. + +.. code-block:: console + + spp > sec 1;status + recv:7:{Client ID 1 Running + 1 + port id: 0,on,PHY,outport: none + port id: 1,on,PHY,outport: none + } + + +stop +---- + +Stop forwarding. + +.. code-block:: console + + spp > sec 1;stop + recv:7:{start forwarding} + +Running status is changed from ``Running`` to ``Idling`` by +executing it. + +.. code-block:: console + + spp > sec 1;status + recv:7:{Client ID 1 Running + 1 + port id: 0,on,PHY,outport: none + port id: 1,on,PHY,outport: none + } + + +del +--- + +Delete PMD added by ``add`` subcommand from the secondary. + +.. code-block:: console + + spp> sec 1;del ring 0 + recv:7:{delring0} + + +exit +---- + +Terminate the secondary. For terminating all secondaries, use ``bye sec`` +command instead of it. + +.. code-block:: console + + spp> sec 1;exit + recv:7:{delring0} -- 2.7.4