From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id 78FA21B5D8 for ; Thu, 10 Jan 2019 11:28:00 +0100 (CET) Received: from vc2.ecl.ntt.co.jp (vc2.ecl.ntt.co.jp [129.60.86.154]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x0AARwj5022825; Thu, 10 Jan 2019 19:27:58 +0900 Received: from vc2.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc2.ecl.ntt.co.jp (Postfix) with ESMTP id 8C19863892A; Thu, 10 Jan 2019 19:27:58 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc2.ecl.ntt.co.jp (Postfix) with ESMTP id 7DEEF638909; Thu, 10 Jan 2019 19:27:58 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp Date: Thu, 10 Jan 2019 19:25:40 +0900 Message-Id: <1547115947-27671-2-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1547115947-27671-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1547086216-27422-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> <1547115947-27671-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH v2 1/8] docs: add desc of overview of SPP secondary 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, 10 Jan 2019 10:28:01 -0000 From: Yasufumi Ogawa Add descriptions of overview of SPP secondary processes in design section. Signed-off-by: Yasufumi Ogawa --- docs/guides/design/spp_secondary.rst | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/guides/design/spp_secondary.rst b/docs/guides/design/spp_secondary.rst index d83ac6a..b3bb270 100644 --- a/docs/guides/design/spp_secondary.rst +++ b/docs/guides/design/spp_secondary.rst @@ -2,15 +2,37 @@ Copyright(c) 2019 Nippon Telegraph and Telephone Corporation -.. _spp_overview_design_spp_secondary: +.. _spp_design_spp_secondary: SPP Secondary ============= -SPP secondary process is ... +SPP secondary process is a worker process in client-server multp-process +application model. Basically, the role of secondary process is to connenct +each of application running on host, containers or VMs for packet forwarding. +Spp secondary process forwards packets from source port to destination port +with DPDK's high-performance forwarding mechanizm. In other word, it behaves +as a cable to connect two patches ports. +All of secondary processes are able to attach ring PMD and vhost PMD ports +for sending or receiving packets with other processes. Ring port is used to +communicate with a process running on host or container if it is implemented +as secondary process to access shared ring memory. +Vhost port is used for a process on container or VM and implemented as primary +process, and no need to access shared memory of SPP primary. -.. _spp_overview_design_spp_secondary_nfv: +In addition to the basic forwarding, SPP secondary process provides several +networking features. One of the typical example is packet cauture. +``spp_nfv`` is the simplest SPP secondary and used to connect two of processes +or other feature ports including PCAP PMD port. PCAP PMD is to dump packets to +a file or retrieve from. + +There are more specific or funcional features than ``spp_nfv``. ``spp_vf`` is +a simple pseudo SR-IOV feature for classifying or merging packets. +``spp_mirror`` is to duplicate incoming packets to several destination ports. + + +.. _spp_design_spp_secondary_nfv: spp_nfv ------- -- 2.7.4