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 BF5291B01C for ; Tue, 16 Jan 2018 06:16:45 +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 w0G5GibN008005 for unknown; Tue, 16 Jan 2018 14:16:44 +0900 Received: (from root@localhost) by gwchk03.silk.ntt-tx.co.jp (unknown) id w0G5GiOs025514 for unknown; Tue, 16 Jan 2018 14:16:44 +0900 Received: from gwchk.silk.ntt-tx.co.jp [10.107.0.110] by gwchk03.silk.ntt-tx.co.jp with ESMTP id QAA25511; Tue, 16 Jan 2018 14:16:43 +0900 Received: from imss03.silk.ntt-tx.co.jp (localhost [127.0.0.1]) by imss03.silk.ntt-tx.co.jp (unknown) with ESMTP id w0G5Ghsr009234 for unknown; Tue, 16 Jan 2018 14:16:43 +0900 Received: from mgate02.silk.ntt-tx.co.jp (smtp02.silk.ntt-tx.co.jp [10.107.0.37]) by imss03.silk.ntt-tx.co.jp (unknown) with ESMTP id w0G5GhQI009226 for unknown; Tue, 16 Jan 2018 14:16:43 +0900 Message-Id: <201801160516.w0G5GhQI009226@imss03.silk.ntt-tx.co.jp> Received: from localhost by mgate02.silk.ntt-tx.co.jp (unknown) id w0G5GfxD026680 ; Tue, 16 Jan 2018 14:16:43 +0900 From: x-fn-spp@sl.ntt-tx.co.jp To: spp@dpdk.org Date: Tue, 16 Jan 2018 14:16:40 +0900 X-Mailer: git-send-email 1.9.1 In-Reply-To: <3e13a243-6c3f-d849-f2f4-67732e5a44cb@intel.com> References: <3e13a243-6c3f-d849-f2f4-67732e5a44cb@intel.com> X-TM-AS-MML: No Subject: [spp] [PATCH 29/30] doc: update sample config section 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: Tue, 16 Jan 2018 05:16:46 -0000 From: Hiroyuki Nakamura Update "Sample Config" section in config_manual.md according to the latest config version format. Some errors are corrected. * Replace network diagram ascii art to the link to spp_sample_config.svg. * Change config example to the one aligned to the network diagram. * Remove comments in config example since no comment is allowed in config file. Signed-off-by: Kentaro Watanabe Signed-off-by: Naoki Takada --- docs/spp_vf/config_manual.md | 110 +-- docs/spp_vf/spp_sample_config.svg | 1865 +++++++++++++++++++++++++++++++++++++ 2 files changed, 1878 insertions(+), 97 deletions(-) create mode 100644 docs/spp_vf/spp_sample_config.svg diff --git a/docs/spp_vf/config_manual.md b/docs/spp_vf/config_manual.md index 05a342c..6a741cc 100644 --- a/docs/spp_vf/config_manual.md +++ b/docs/spp_vf/config_manual.md @@ -50,22 +50,21 @@ Here is default config `spp.json` and network diagram of it. "vfs": [ { "name": "vf0", - "num_vhost": 4, // Number of vhosts - "num_ring": 9, // Number of rings - "functions":[ // Attributes of forward,merge or classifier_mac + "num_vhost": 2, + "num_ring": 4, + "functions":[ { - "core": 2, // Core ID - "type": "merge", // Forwarder type - "rx_port": ["phy:0", "phy:1"], // Rx port, It MUST be a list for merge type - "tx_port": "ring:8" // Tx port + "core": 2, + "type": "classifier_mac", + "rx_port": "phy:0", + "tx_port": ["ring:0", "ring:1"] }, { "core": 3, - "type": "classifier_mac", - "rx_port": "ring:8", // Rx port, It is not a list because type is classifier_mac - "tx_port": ["ring:0", "ring:1", "ring:4", "ring:5"] + "type": "merge", + "rx_port": ["ring:2", "ring:3"], + "tx_port": "phy:0" }, - { "core": 4, "type": "forward", @@ -76,7 +75,7 @@ Here is default config `spp.json` and network diagram of it. "core": 5, "type": "forward", "rx_port": "ring:1", - "tx_port": "vhost:2" + "tx_port": "vhost:1" }, { "core": 6, @@ -87,45 +86,8 @@ Here is default config `spp.json` and network diagram of it. { "core": 7, "type": "forward", - "rx_port": "vhost:2", - "tx_port": "ring:3" - }, - { - "core": 8, - "type": "merge", - "rx_port": ["ring:2", "ring:3"], - "tx_port": "phy:0" - }, - - { - "core": 9, - "type": "forward", - "rx_port": "ring:4", - "tx_port": "vhost:1" - }, - { - "core": 10, - "type": "forward", - "rx_port": "ring:5", - "tx_port": "vhost:3" - }, - { - "core": 11, - "type": "forward", "rx_port": "vhost:1", - "tx_port": "ring:6" - }, - { - "core": 12, - "type": "forward", - "rx_port": "vhost:3", - "tx_port": "ring:7" - }, - { - "core": 13, - "type": "merge", - "rx_port": ["ring:6", "ring:7"], - "tx_port": "phy:1" + "tx_port": "ring:3" } ] } @@ -134,50 +96,4 @@ Here is default config `spp.json` and network diagram of it. ``` Network diagram -[TODO] Replace it to more readable SVG img. - -``` -+---------+ +-----------------------------------------------------------------------------------------------+ -| host2 | | Host1 | -| | | +------------------------------------------------------+ +-------------------+ | -| | | | spp_vf | | | | -| +-----+ | | +--------+ | +---+ +----+ +---+ +----+ +---+ +----------+ | | +----------+ | | -| | nic <------> nic0 +-----> M +--> r8 +--> C +-----> r0 +--> F +--> +------> | | | -| +-----+ | | +----+---+ | +-^-+ +----+ +-+-+ +----+ +---+ | | | | | | | | -| | | ^ | | | | vhost0 | | | | nic | | | -| | | | | | | +----+ +---+ | | | | | | | | -| | | | | | +--------------+ r2 <--+ F <--+ <------+ | | | -| | | | | | | | +----+ +---+ +----------+ | | +----------+ | | -| | | | | | | | | | spp vm| | -| | | | | | | | +----+ +---+ +----------+ | | +----------+ | | -| | | | | | | +-------> r4 +--+ F +--> +------> | | | -| | | | | | +--v--+ | +----+ +---+ | | | | | | | | -| | | +----------------+ M | | | vhost1 | | | | nic | | | -| | | | | +--^--+ | +----+ +---+ | | | | | | | | -| | | | | | +------------+ r6 +--+ F <--+ <------+ | | | -| | | | | | | | +----+ +---+ +----------+ | | +----------+ | | -| | | | | | | | | | | | -| | | | | | | | | +-------------------+ | -| | | | | | | | | | -| | | | | | | | | +-------------------+ | -| | | | | | | | | | | | -| +-----+ | | +--------+ | | | | | +----+ +---+ +----------+ | | +----------+ | | -| | nic <------> nic1 +-------+ | | +-------> r1 +--+ F +--> +------> | | | -| +-----+ | | +----+---+ | | | | +----+ +---+ | | | | | | | | -| | | ^ | | | | | vhost2 | | | | nic | | | -| | | | | | | | +----+ +---+ | | | | | | | | -| | | | | +--------------+ r3 +--+ F <--+ <------+ | | | -| | | | | | | +----+ +---+ +----------+ | | +----------+ | | -| | | | | | | | | spp vm| | -| | | | | | | +----+ +---+ +----------+ | | +----------+ | | -| | | | | | +-------> r5 +--+ F +--> +------> | | | -| | | | | +----v+ +----+ +---+ | | | | | | | | -| | | +----------------+ M | | vhost3 | | | | nic | | | -| | | | +--^--+ +----+ +---+ | | | | | | | | -| | | | +--------------+ r7 +--+ F <--+ <------+ | | | -| | | | +----+ +---+ +----------+ | | +----------+ | | -| | | | | | | | -| | | +------------------------------------------------------+ +-------------------+ | -| | | | -+---------+ +-----------------------------------------------------------------------------------------------+ -``` +![spp_sample_config](spp_sample_config.svg) diff --git a/docs/spp_vf/spp_sample_config.svg b/docs/spp_vf/spp_sample_config.svg new file mode 100644 index 0000000..00069f3 --- /dev/null +++ b/docs/spp_vf/spp_sample_config.svg @@ -0,0 +1,1865 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + host1 + + NIC0 + + host2 + + NIC1 + + + + network + + + + + + spp_vf + + + + guest vm1 + + guest vm2 + + vNIC + + vNIC + + + + + + + classifier + + + + vhost1 + + + + + + + + + + + merger + + + forwarder + + + + forwarder + + + + forwarder + + + + forwarder + + + traffic generator + + + + app2 + + + + app1 + + + + + + vhost0 + + + + + ring + + ring0 + + + ring + + ring1 + + + ring + + ring2 + + + ring + + ring3 + + -- 1.9.1