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 A01941B018 for ; Tue, 16 Jan 2018 06:16:46 +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 w0G5Gj3J008029 for unknown; Tue, 16 Jan 2018 14:16:45 +0900 Received: (from root@localhost) by gwchk03.silk.ntt-tx.co.jp (unknown) id w0G5GiRV025523 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 QAA25515; Tue, 16 Jan 2018 14:16:44 +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 w0G5GhMT009241 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 w0G5Ghqj009221 for unknown; Tue, 16 Jan 2018 14:16:43 +0900 Message-Id: <201801160516.w0G5Ghqj009221@imss03.silk.ntt-tx.co.jp> Received: from localhost by mgate02.silk.ntt-tx.co.jp (unknown) id w0G5Gfx9026680 ; Tue, 16 Jan 2018 14:16:42 +0900 From: x-fn-spp@sl.ntt-tx.co.jp To: spp@dpdk.org Date: Tue, 16 Jan 2018 14:16:36 +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 25/30] doc: add how to use vhost-user support 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:47 -0000 From: Hiroyuki Nakamura add description on how to use vhost-user client mode. * Add information on qemu-kvm version. * Add and explan optional parameters of spp_vf. * Update qemu parameter for vhost. (xml set by virsh) Signed-off-by: Kentaro Watanabe Signed-off-by: Naoki Takada --- docs/spp_vf/how_to_use.md | 24 ++++++++++++++++++++---- docs/spp_vf/sample_usage.md | 10 ++++++---- docs/spp_vf/setup_guide.md | 10 +++++----- 3 files changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/spp_vf/how_to_use.md b/docs/spp_vf/how_to_use.md index dee4465..32c1774 100644 --- a/docs/spp_vf/how_to_use.md +++ b/docs/spp_vf/how_to_use.md @@ -9,7 +9,7 @@ SPP_VF is a SR-IOV like network functionality for NFV. ## Environment * Ubuntu 16.04 -* qemu-kvm +* qemu-kvm 2.7 or later * DPDK v17.05 or later ## Launch SPP @@ -56,7 +56,10 @@ In `spp_vf`, spp secondary processes are launched by single command. Option of dpdk are refer to [dpdk documentation](http://dpdk.org/doc/guides/linux_gsg/build_sample_apps.html#running-a-sample-application). Options of `spp_vf` are - * TODO + * --client-id : client id + * --config : config file path + * -s : Port for ip addr and spp secondary + * --vhost-client : vhost-user client enable setting Core assingment and network configuration are defined in JSON formatted config file. @@ -65,7 +68,19 @@ config file (test/spp_config/spp_config/vf.json). ```sh $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \ --c 0x3ffd -n 4 --proc-type=secondary +-c 0x3ffd -n 4 --proc-type=secondary \ +-- --client-id 1 -s 127.0.0.1:6666 --vhost-client +``` + +`--vhost-client` option is used when SPP is a client of vhost-user. +By choosing not to use `--vhost-client` option, +It may be possible to use SPP even in qemu (before 2.7 version) +which can not be used as a vhost-user server. + +```sh +$ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \ +-c 0x3ffd -n 4 --proc-type=secondary \ +-- --client-id 1 -s 127.0.0.1:6666 ``` You can also indicate which of config you use explicitly with @@ -78,7 +93,8 @@ defined in each of config files. ```sh $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \ -c 0x3ffd -n 4 --proc-type=secondary \ --- --config /path/to/config/spp_vf1.json +-- --client-id 1 --config /path/to/config/spp_vf1.json \ +-s 127.0.0.1:6666 --vhost-client ``` ### SPP VM diff --git a/docs/spp_vf/sample_usage.md b/docs/spp_vf/sample_usage.md index dcc051a..47abbec 100644 --- a/docs/spp_vf/sample_usage.md +++ b/docs/spp_vf/sample_usage.md @@ -41,17 +41,19 @@ launch secondary process after launch primary process. $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \ -c 0x00fd -n 4 --proc-type=secondary \ -- \ - --process-id 1 \ + --client-id 1 \ --config /path/to/spp_vf1_without_cmtab.json \ - -s 127.0.0.1:11111 + -s 127.0.0.1:11111 \ + --vhost-client # start secondary 2 $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \ -c 0x3f01 -n 4 --proc-type=secondary \ -- \ - --process-id 2 \ + --client-id 2 \ --config /path/to/spp_vf2_without_cmtab.json \ - -s 127.0.0.1:11112 + -s 127.0.0.1:11112 \ + --vhost-client ``` ### Setup network configuration for VMs diff --git a/docs/spp_vf/setup_guide.md b/docs/spp_vf/setup_guide.md index 4684cf3..f24e43e 100644 --- a/docs/spp_vf/setup_guide.md +++ b/docs/spp_vf/setup_guide.md @@ -3,7 +3,7 @@ ## Environment * Ubuntu 16.04 -* qemu-kvm +* qemu-kvm 2.7 or later * DPDK v17.05 or later ## Setting @@ -205,15 +205,15 @@ $ virsh edit [VM_NAME] - + - + - + - + -- 1.9.1