Soft Patch Panel
 help / color / mirror / Atom feed
* [spp] [PATCH 0/2] doc:Fix error and improve document under spp_vf
@ 2018-05-09  5:43 x-fn-spp
  2018-05-09  6:33 ` Yasufumi Ogawa
  0 siblings, 1 reply; 19+ messages in thread
From: x-fn-spp @ 2018-05-09  5:43 UTC (permalink / raw)
  To: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

Hello, this patch set fix and improve document related to spp_vf.

Hideyuki-Yamashita (2):
  doc: Fix document error under spp_vf directory
  doc: Improve document under spp_vf directory

 docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
 docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
 2 files changed, 91 insertions(+), 51 deletions(-)

-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [spp] [PATCH 0/2] doc:Fix error and improve document under spp_vf
  2018-05-09  5:43 [spp] [PATCH 0/2] doc:Fix error and improve document under spp_vf x-fn-spp
@ 2018-05-09  6:33 ` Yasufumi Ogawa
  2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
                     ` (2 more replies)
  0 siblings, 3 replies; 19+ messages in thread
From: Yasufumi Ogawa @ 2018-05-09  6:33 UTC (permalink / raw)
  To: x-fn-spp; +Cc: spp, ogawa.yasufumi, ferruh.yigit

On 2018/05/09 14:43, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> 
> Hello, this patch set fix and improve document related to spp_vf.
> 
> Hideyuki-Yamashita (2):
>    doc: Fix document error under spp_vf directory
>    doc: Improve document under spp_vf directory
Hideyuki,

Thank you for your first contribution!

I would like to review your patches. However, could you update them before because commit messages are not appripriate? You need 
to start subject from "docs: " (not "doc: ") and follow lowercase, "Fix" should be "fix" and also "Improve" should be "improve".

Could you make updated patches with version number "2" with -v option like as following example?
$ git format-patch d63ef8c -o ~/patch/ -v 2

Please refer DPDK contribution guide for details.
http://dpdk.org/doc/guides/contributing/patches.html

Thanks,
Yasufumi
> 
>   docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
>   docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
>   2 files changed, 91 insertions(+), 51 deletions(-)
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v2 0/2] doc:fix error and improve document under spp_vf
  2018-05-09  6:33 ` Yasufumi Ogawa
@ 2018-05-09  6:57   ` x-fn-spp
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
                       ` (2 more replies)
  2018-05-09  6:58   ` [spp] [PATCH v2 1/2] docs: fix document error " x-fn-spp
  2018-05-09  6:58   ` [spp] [PATCH v2 2/2] docs: improve document " x-fn-spp
  2 siblings, 3 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-09  6:57 UTC (permalink / raw)
  To: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

Hello Yasufumi-san,

Thanks for your reply.
And appologies about using wrong format for commit messages.
I send v2 patch set which follows your guidance.

BR,
Hideyuki Yamashita

Hideyuki-Yamashita (2):
  docs: fix document error under spp_vf directory
  docs: improve document under spp_vf directory

 docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
 docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
 2 files changed, 91 insertions(+), 51 deletions(-)

-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v2 1/2] docs: fix document error under spp_vf directory
  2018-05-09  6:33 ` Yasufumi Ogawa
  2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
@ 2018-05-09  6:58   ` x-fn-spp
  2018-05-11  3:44     ` Yasufumi Ogawa
  2018-05-09  6:58   ` [spp] [PATCH v2 2/2] docs: improve document " x-fn-spp
  2 siblings, 1 reply; 19+ messages in thread
From: x-fn-spp @ 2018-05-09  6:58 UTC (permalink / raw)
  To: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

- Fix typo in build.rst
- Fix typo and error in usecase1.rst

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          |  4 +-
 docs/guides/spp_vf/use_cases/usecase1.rst | 80 +++++++++++++++----------------
 2 files changed, 41 insertions(+), 43 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index a37f86a..52611dc 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -79,7 +79,7 @@ You need to run ``update-grub`` and reboot to activate grub config.
 
 .. code-block:: console
 
-    $ sudo upadte-grub
+    $ sudo update-grub
     $ sudo reboot
 
 
@@ -101,7 +101,7 @@ You can check hugepage settings as following.
     hugetlbfs-kvm on /run/hugepages/kvm type hugetlbfs (rw,relatime,mode=775,gid=117)
     hugetlb on /run/lxcfs/controllers/hugetlb type cgroup (rw,relatime,hugetlb,release_agent=/run/cgmanager/agents/cgm-release-agent.hugetlb,nsroot=/)
 
-Finally, you unmount default hugepage.
+Finally, you umount default hugepage.
 
 .. code-block:: console
 
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index 080aba1..b5256e5 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -82,7 +82,7 @@ After ``spp_primary`` is launched, run secondary process ``spp_vf``.
 .. code-block:: console
 
     $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
-        -c 0x00fe -n 4 --proc-type=secondary \
+        -c 0x3ffd -n 4 --proc-type=secondary \
         -- \
         --client-id 1 \
         -s 127.0.0.1:6666 \
@@ -156,14 +156,14 @@ merger has two rx ports.
     spp > sec 1;port add ring:0 rx forwarder1
     spp > sec 1;port add vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port add vhost:0 rx forwarder2
-    spp > sec 1;port add ring:2 tx forwarder2
+    spp > sec 1;port add ring:1 rx forwarder2
+    spp > sec 1;port add vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port add ring:1 rx forwarder3
-    spp > sec 1;port add vhost:2 rx forwarder3
+    spp > sec 1;port add vhost:0 rx forwarder3
+    spp > sec 1;port add ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port add vhost:2 tx forwarder4
-    spp > sec 1;port add ring:3 rx forwarder4
+    spp > sec 1;port add vhost:2 rx forwarder4
+    spp > sec 1;port add ring:3 tx forwarder4
     # merger1
     spp > sec 1;port add ring:2 rx merger1
     spp > sec 1;port add ring:3 rx merger1
@@ -213,14 +213,14 @@ Add ports to each of components.
     spp > sec 1;port add ring:4 rx forwarder5
     spp > sec 1;port add vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port add vhost:1 rx forwarder6
-    spp > sec 1;port add ring:6 tx forwarder6
+    spp > sec 1;port add ring:5 rx forwarder6
+    spp > sec 1;port add vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port add ring:5 rx forwarder7
-    spp > sec 1;port add vhost:3 rx forwarder7
+    spp > sec 1;port add vhost:1 rx forwarder7
+    spp > sec 1;port add ring:6 tx forwarder7
     # forwarder8
-    spp > sec 1;port add vhost:3 tx forwarder8
-    spp > sec 1;port add ring:7 rx forwarder8
+    spp > sec 1;port add vhost:3 rx forwarder8
+    spp > sec 1;port add ring:7 tx forwarder8
     # merger2
     spp > sec 1;port add ring:6 rx merger2
     spp > sec 1;port add ring:7 rx merger2
@@ -287,8 +287,6 @@ Configurations also for ``spp-vm2`` as ``spp-vm1``.
 
 .. code-block:: console
 
-    $ ssh -oStrictHostKeyChecking=no sppuser@192.168.122.32
-
     # up interfaces
     $ sudo ifconfig ens4 inet 192.168.140.31 netmask 255.255.255.0 up
     $ sudo ifconfig ens5 inet 192.168.150.32 netmask 255.255.255.0 up
@@ -340,21 +338,21 @@ for the first SSH login path.
     spp > sec 1;port del ring:0 tx classifier1
     spp > sec 1;port del ring:1 tx classifier1
     # forwarder1
-    spp > sec 1;port del ring:0 rx forward1
-    spp > sec 1;port del vhost:0 tx forward1
+    spp > sec 1;port del ring:0 rx forwarder1
+    spp > sec 1;port del vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port del vhost:0 rx forward2
-    spp > sec 1;port del ring:2 tx forward2
+    spp > sec 1;port del ring:1 rx forwarder2
+    spp > sec 1;port del vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port del ring:1 rx forward3
-    spp > sec 1;port del vhost:2 rx forward3
+    spp > sec 1;port del vhost:0 rx forwarder3
+    spp > sec 1;port del ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port del vhost:2 tx forward4
-    spp > sec 1;port del ring:3 rx forward4
+    spp > sec 1;port del vhost:2 rx forwarder4
+    spp > sec 1;port del ring:3 tx forwarder4
     # merger1
-    spp > sec 1;port del ring:2 rx merge1
-    spp > sec 1;port del ring:3 rx merge1
-    spp > sec 1;port del phy:0 tx merge1
+    spp > sec 1;port del ring:2 rx merger1
+    spp > sec 1;port del ring:3 rx merger1
+    spp > sec 1;port del phy:0 tx merger1
 
 Then, stop components.
 
@@ -362,11 +360,11 @@ Then, stop components.
 
     # Stop component to spp_vf
     spp > sec 1;component stop classifier1
-    spp > sec 1;component stop forward1
-    spp > sec 1;component stop forward2
-    spp > sec 1;component stop forward3
-    spp > sec 1;component stop forward4
-    spp > sec 1;component stop merge1
+    spp > sec 1;component stop forwarder1
+    spp > sec 1;component stop forwarder2
+    spp > sec 1;component stop forwarder3
+    spp > sec 1;component stop forwarder4
+    spp > sec 1;component stop merger1
 
 Second, do termination for the second path.
 Delete entries from ``classifier_table`` and ports from each of
@@ -388,11 +386,11 @@ components.
     spp > sec 1;port del ring:4 rx forwarder5
     spp > sec 1;port del vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port del vhost:1 rx forwarder6
-    spp > sec 1;port del ring:6 tx forwarder6
+    spp > sec 1;port del ring:5 rx forwarder6
+    spp > sec 1;port del vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port del ring:5 rx forwarder7
-    spp > sec 1;port del vhost:3 rx forwarder7
+    spp > sec 1;port del vhost:1 rx forwarder7
+    spp > sec 1;port del ring:6 tx forwarder7
     # forwarder8
     spp > sec 1;port del vhost:3 tx forwarder8
     spp > sec 1;port del ring:7 rx forwarder8
@@ -406,12 +404,12 @@ Then, stop components.
 .. code-block:: console
 
     # Stop component to spp_vf
-    spp > sec 1;component stop classifier2 8 classifier_mac
-    spp > sec 1;component stop forward5 9 forward
-    spp > sec 1;component stop forward6 10 forward
-    spp > sec 1;component stop forward7 11 forward
-    spp > sec 1;component stop forward8 12 forward
-    spp > sec 1;component stop merge2 13 merge
+    spp > sec 1;component stop classifier2
+    spp > sec 1;component stop forwarder5
+    spp > sec 1;component stop forwarder6
+    spp > sec 1;component stop forwarder7
+    spp > sec 1;component stop forwarder8
+    spp > sec 1;component stop merger2
 
 Finally, run ``flush`` subcommand.
 
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v2 2/2] docs: improve document under spp_vf directory
  2018-05-09  6:33 ` Yasufumi Ogawa
  2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
  2018-05-09  6:58   ` [spp] [PATCH v2 1/2] docs: fix document error " x-fn-spp
@ 2018-05-09  6:58   ` x-fn-spp
  2018-05-11  4:23     ` Yasufumi Ogawa
  2 siblings, 1 reply; 19+ messages in thread
From: x-fn-spp @ 2018-05-09  6:58 UTC (permalink / raw)
  To: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

    - Add detail about where to edit using virsh edit command in build.rst
    - Change command in Trouble Shooting Guide in build.rst
    - Additional note when registering MAC address to classfier in usecase1.rst

    Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
    Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          | 49 ++++++++++++++++++++++++++-----
 docs/guides/spp_vf/use_cases/usecase1.rst |  9 ++++++
 2 files changed, 50 insertions(+), 8 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 52611dc..1a8e114 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -30,7 +30,7 @@
 
 .. _spp_vf_gsg_build:
 
-Build
+Setup
 =====
 
 Environment
@@ -165,6 +165,32 @@ Then, bind it with PCI_Number.
 
 virsh setup
 -----------
+.. note::
+
+    This document assumes that VM is already installed. If not please follow the instruction below and install the VM.
+
+.. code-block:: console
+
+   virt-install \
+   --name ${VMNAME} \
+   --ram 4096 \
+   --disk path=/var/lib/libvirt/images/${VMNAME}.img,size=30 \
+   --vcpus 4 \
+   --os-type linux \
+   --os-variant ubuntu16.04 \
+   --network network=default \
+   --graphics none \
+   --console pty,target_type=serial \
+   --location 'http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/' \
+   --extra-args 'console=ttyS0,115200n8 serial'
+
+You may need type the following commands through ssh to activate console.
+
+.. code-block:: console
+
+    $sudo systemctl enable serial-getty@ttyS0.service
+    $sudo systemctl start serial-getty@ttyS0.service
+
 
 Edit VM configuration with virsh.
 
@@ -172,6 +198,13 @@ Edit VM configuration with virsh.
 
     $ virsh edit [VM_NAME]
 
+You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` into the domain tag because of adding ``<qemu:commandline>`` tag.
+In addition, you need to add the tag enclosed by ``<memoryBacking>`` and ``</memoryBacking>``, ``<qemu:commandline>`` and ``</qemu:commandline>`` because SPP uses vhost-user as interface with VM.
+Note that number used in those tags should be the same value (e.g. chr0,sock0,vhost-net0) and these values should correspond to "add vhost N" (in this example 0).
+MAC address used in ``<qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>`` can be specified when registering MAC address to classifier using Secondary command.
+
+        The following is an example of modified xml file:
+
 .. code-block:: xml
 
     <domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
@@ -266,13 +299,13 @@ In this case, you should try it.
 
 .. code-block:: console
 
-    $ sudo ln -s /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper /etc/apparmor.d/disable/usr.lib.libvirt.virt-aa-helper
-    $ sudo ln -s /etc/apparmor.d/usr.sbin.libvirtd /etc/apparmor.d/disable/usr.sbin.libvirtd
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
-    $ sudo service apparmor reload
-    $ sudo service apparmor restart
-    $ sudo service libvirt-bin restart
+    #Edit /etc/libvirt/qemu.conf and set security_driver to none:
+    $sudo vi /etc/libvirt/qemu.conf
+    ...
+    security_driver = "none"
+    ...
+    #Restart libvirtd:
+    $sudo systemctl restart libvirtd.service
 
 Or, you remove appamor.
 
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index b5256e5..6a4f62f 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -186,6 +186,10 @@ In this usecase, you need to register two MAC addresses for merger1.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:56 ring:0
     spp > sec 1;classifier_table add mac 52:54:00:12:34:58 ring:1
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
 
 Configuration for the second login path is almost similar to the first
 path.
@@ -234,6 +238,11 @@ Register entries to classifier_table for classifier2.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:57 ring:4
     spp > sec 1;classifier_table add mac 52:54:00:12:34:59 ring:5
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
+
 Finally, activate all of settings by doign `flush` subcommand.
 
 .. code-block:: console
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [spp] [PATCH v2 1/2] docs: fix document error under spp_vf directory
  2018-05-09  6:58   ` [spp] [PATCH v2 1/2] docs: fix document error " x-fn-spp
@ 2018-05-11  3:44     ` Yasufumi Ogawa
  0 siblings, 0 replies; 19+ messages in thread
From: Yasufumi Ogawa @ 2018-05-11  3:44 UTC (permalink / raw)
  To: x-fn-spp; +Cc: spp, ferruh.yigit, ogawa.yasufumi

On 2018/05/09 15:58, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> 
> - Fix typo in build.rst
> - Fix typo and error in usecase1.rst
Hi Hideyuki,

You fixed wrong command name 'unmount' in description, but still remains the codeblock.
+Finally, you umount default hugepage.
$ sudo unmount /dev/hugepages

Could you give us a bit more detailed summary for 2nd topic, correcting usecase, to explain what was wrong. For example, "Fix 
incorrect configuration. Coremask should be '0x3ffd', not '0x00fe'. And there are many mistakes for assigning resource IDs while 
setting up spp_vf."

Thanks,
Yasufumi
> 
> Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
>   docs/guides/spp_vf/gsg/build.rst          |  4 +-
>   docs/guides/spp_vf/use_cases/usecase1.rst | 80 +++++++++++++++----------------
>   2 files changed, 41 insertions(+), 43 deletions(-)
> 
> diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
> index a37f86a..52611dc 100644
> --- a/docs/guides/spp_vf/gsg/build.rst
> +++ b/docs/guides/spp_vf/gsg/build.rst
> @@ -79,7 +79,7 @@ You need to run ``update-grub`` and reboot to activate grub config.
>   
>   .. code-block:: console
>   
> -    $ sudo upadte-grub
> +    $ sudo update-grub
>       $ sudo reboot
>   
>   
> @@ -101,7 +101,7 @@ You can check hugepage settings as following.
>       hugetlbfs-kvm on /run/hugepages/kvm type hugetlbfs (rw,relatime,mode=775,gid=117)
>       hugetlb on /run/lxcfs/controllers/hugetlb type cgroup (rw,relatime,hugetlb,release_agent=/run/cgmanager/agents/cgm-release-agent.hugetlb,nsroot=/)
>   
> -Finally, you unmount default hugepage.
> +Finally, you umount default hugepage.
>   
>   .. code-block:: console
>   
> diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
> index 080aba1..b5256e5 100644
> --- a/docs/guides/spp_vf/use_cases/usecase1.rst
> +++ b/docs/guides/spp_vf/use_cases/usecase1.rst
> @@ -82,7 +82,7 @@ After ``spp_primary`` is launched, run secondary process ``spp_vf``.
>   .. code-block:: console
>   
>       $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
> -        -c 0x00fe -n 4 --proc-type=secondary \
> +        -c 0x3ffd -n 4 --proc-type=secondary \
>           -- \
>           --client-id 1 \
>           -s 127.0.0.1:6666 \
> @@ -156,14 +156,14 @@ merger has two rx ports.
>       spp > sec 1;port add ring:0 rx forwarder1
>       spp > sec 1;port add vhost:0 tx forwarder1
>       # forwarder2
> -    spp > sec 1;port add vhost:0 rx forwarder2
> -    spp > sec 1;port add ring:2 tx forwarder2
> +    spp > sec 1;port add ring:1 rx forwarder2
> +    spp > sec 1;port add vhost:2 tx forwarder2
>       # forwarder3
> -    spp > sec 1;port add ring:1 rx forwarder3
> -    spp > sec 1;port add vhost:2 rx forwarder3
> +    spp > sec 1;port add vhost:0 rx forwarder3
> +    spp > sec 1;port add ring:2 tx forwarder3
>       # forwarder4
> -    spp > sec 1;port add vhost:2 tx forwarder4
> -    spp > sec 1;port add ring:3 rx forwarder4
> +    spp > sec 1;port add vhost:2 rx forwarder4
> +    spp > sec 1;port add ring:3 tx forwarder4
>       # merger1
>       spp > sec 1;port add ring:2 rx merger1
>       spp > sec 1;port add ring:3 rx merger1
> @@ -213,14 +213,14 @@ Add ports to each of components.
>       spp > sec 1;port add ring:4 rx forwarder5
>       spp > sec 1;port add vhost:1 tx forwarder5
>       # forwarder6
> -    spp > sec 1;port add vhost:1 rx forwarder6
> -    spp > sec 1;port add ring:6 tx forwarder6
> +    spp > sec 1;port add ring:5 rx forwarder6
> +    spp > sec 1;port add vhost:3 tx forwarder6
>       # forwarder7
> -    spp > sec 1;port add ring:5 rx forwarder7
> -    spp > sec 1;port add vhost:3 rx forwarder7
> +    spp > sec 1;port add vhost:1 rx forwarder7
> +    spp > sec 1;port add ring:6 tx forwarder7
>       # forwarder8
> -    spp > sec 1;port add vhost:3 tx forwarder8
> -    spp > sec 1;port add ring:7 rx forwarder8
> +    spp > sec 1;port add vhost:3 rx forwarder8
> +    spp > sec 1;port add ring:7 tx forwarder8
>       # merger2
>       spp > sec 1;port add ring:6 rx merger2
>       spp > sec 1;port add ring:7 rx merger2
> @@ -287,8 +287,6 @@ Configurations also for ``spp-vm2`` as ``spp-vm1``.
>   
>   .. code-block:: console
>   
> -    $ ssh -oStrictHostKeyChecking=no sppuser@192.168.122.32
> -
>       # up interfaces
>       $ sudo ifconfig ens4 inet 192.168.140.31 netmask 255.255.255.0 up
>       $ sudo ifconfig ens5 inet 192.168.150.32 netmask 255.255.255.0 up
> @@ -340,21 +338,21 @@ for the first SSH login path.
>       spp > sec 1;port del ring:0 tx classifier1
>       spp > sec 1;port del ring:1 tx classifier1
>       # forwarder1
> -    spp > sec 1;port del ring:0 rx forward1
> -    spp > sec 1;port del vhost:0 tx forward1
> +    spp > sec 1;port del ring:0 rx forwarder1
> +    spp > sec 1;port del vhost:0 tx forwarder1
>       # forwarder2
> -    spp > sec 1;port del vhost:0 rx forward2
> -    spp > sec 1;port del ring:2 tx forward2
> +    spp > sec 1;port del ring:1 rx forwarder2
> +    spp > sec 1;port del vhost:2 tx forwarder2
>       # forwarder3
> -    spp > sec 1;port del ring:1 rx forward3
> -    spp > sec 1;port del vhost:2 rx forward3
> +    spp > sec 1;port del vhost:0 rx forwarder3
> +    spp > sec 1;port del ring:2 tx forwarder3
>       # forwarder4
> -    spp > sec 1;port del vhost:2 tx forward4
> -    spp > sec 1;port del ring:3 rx forward4
> +    spp > sec 1;port del vhost:2 rx forwarder4
> +    spp > sec 1;port del ring:3 tx forwarder4
>       # merger1
> -    spp > sec 1;port del ring:2 rx merge1
> -    spp > sec 1;port del ring:3 rx merge1
> -    spp > sec 1;port del phy:0 tx merge1
> +    spp > sec 1;port del ring:2 rx merger1
> +    spp > sec 1;port del ring:3 rx merger1
> +    spp > sec 1;port del phy:0 tx merger1
>   
>   Then, stop components.
>   
> @@ -362,11 +360,11 @@ Then, stop components.
>   
>       # Stop component to spp_vf
>       spp > sec 1;component stop classifier1
> -    spp > sec 1;component stop forward1
> -    spp > sec 1;component stop forward2
> -    spp > sec 1;component stop forward3
> -    spp > sec 1;component stop forward4
> -    spp > sec 1;component stop merge1
> +    spp > sec 1;component stop forwarder1
> +    spp > sec 1;component stop forwarder2
> +    spp > sec 1;component stop forwarder3
> +    spp > sec 1;component stop forwarder4
> +    spp > sec 1;component stop merger1
>   
>   Second, do termination for the second path.
>   Delete entries from ``classifier_table`` and ports from each of
> @@ -388,11 +386,11 @@ components.
>       spp > sec 1;port del ring:4 rx forwarder5
>       spp > sec 1;port del vhost:1 tx forwarder5
>       # forwarder6
> -    spp > sec 1;port del vhost:1 rx forwarder6
> -    spp > sec 1;port del ring:6 tx forwarder6
> +    spp > sec 1;port del ring:5 rx forwarder6
> +    spp > sec 1;port del vhost:3 tx forwarder6
>       # forwarder7
> -    spp > sec 1;port del ring:5 rx forwarder7
> -    spp > sec 1;port del vhost:3 rx forwarder7
> +    spp > sec 1;port del vhost:1 rx forwarder7
> +    spp > sec 1;port del ring:6 tx forwarder7
>       # forwarder8
>       spp > sec 1;port del vhost:3 tx forwarder8
>       spp > sec 1;port del ring:7 rx forwarder8
> @@ -406,12 +404,12 @@ Then, stop components.
>   .. code-block:: console
>   
>       # Stop component to spp_vf
> -    spp > sec 1;component stop classifier2 8 classifier_mac
> -    spp > sec 1;component stop forward5 9 forward
> -    spp > sec 1;component stop forward6 10 forward
> -    spp > sec 1;component stop forward7 11 forward
> -    spp > sec 1;component stop forward8 12 forward
> -    spp > sec 1;component stop merge2 13 merge
> +    spp > sec 1;component stop classifier2
> +    spp > sec 1;component stop forwarder5
> +    spp > sec 1;component stop forwarder6
> +    spp > sec 1;component stop forwarder7
> +    spp > sec 1;component stop forwarder8
> +    spp > sec 1;component stop merger2
>   
>   Finally, run ``flush`` subcommand.
>   
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [spp] [PATCH v2 2/2] docs: improve document under spp_vf directory
  2018-05-09  6:58   ` [spp] [PATCH v2 2/2] docs: improve document " x-fn-spp
@ 2018-05-11  4:23     ` Yasufumi Ogawa
  0 siblings, 0 replies; 19+ messages in thread
From: Yasufumi Ogawa @ 2018-05-11  4:23 UTC (permalink / raw)
  To: x-fn-spp; +Cc: spp, ferruh.yigit, ogawa.yasufumi

On 2018/05/09 15:58, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> 
>      - Add detail about where to edit using virsh edit command in build.rst
>      - Change command in Trouble Shooting Guide in build.rst
>      - Additional note when registering MAC address to classfier in usecase1.rst
I think it is ambiguous for "assumes that VM is already installed". Do you mean "installed" that the image file is already setup 
(in which SPP is installed) and ready to boot the VM, right?

I am not sure about "${VMNAME}" and "[VM_NAME]". Are there the same name or different? Although I am not so well understanding 
for virsh, I wander the name of '--name ${VMNAME}' and 'virsh edit [VM_NAME]' should be the same, and can be different for 
'${VMNAME}.img'. If so, could you revise it for using correct variable names?

Thanks
> 
>      Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
>      Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
>   docs/guides/spp_vf/gsg/build.rst          | 49 ++++++++++++++++++++++++++-----
>   docs/guides/spp_vf/use_cases/usecase1.rst |  9 ++++++
>   2 files changed, 50 insertions(+), 8 deletions(-)
> 
> diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
> index 52611dc..1a8e114 100644
> --- a/docs/guides/spp_vf/gsg/build.rst
> +++ b/docs/guides/spp_vf/gsg/build.rst
> @@ -30,7 +30,7 @@
>   
>   .. _spp_vf_gsg_build:
>   
> -Build
> +Setup
>   =====
>   
>   Environment
> @@ -165,6 +165,32 @@ Then, bind it with PCI_Number.
>   
>   virsh setup
>   -----------
> +.. note::
> +
> +    This document assumes that VM is already installed. If not please follow the instruction below and install the VM.
> +
> +.. code-block:: console
> +
> +   virt-install \
> +   --name ${VMNAME} \
> +   --ram 4096 \
> +   --disk path=/var/lib/libvirt/images/${VMNAME}.img,size=30 \
> +   --vcpus 4 \
> +   --os-type linux \
> +   --os-variant ubuntu16.04 \
> +   --network network=default \
> +   --graphics none \
> +   --console pty,target_type=serial \
> +   --location 'http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/' \
> +   --extra-args 'console=ttyS0,115200n8 serial'
> +
> +You may need type the following commands through ssh to activate console.
> +
> +.. code-block:: console
> +
> +    $sudo systemctl enable serial-getty@ttyS0.service
> +    $sudo systemctl start serial-getty@ttyS0.service
> +
>   
>   Edit VM configuration with virsh.
>   
> @@ -172,6 +198,13 @@ Edit VM configuration with virsh.
>   
>       $ virsh edit [VM_NAME]
>   
> +You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` into the domain tag because of adding ``<qemu:commandline>`` tag.
> +In addition, you need to add the tag enclosed by ``<memoryBacking>`` and ``</memoryBacking>``, ``<qemu:commandline>`` and ``</qemu:commandline>`` because SPP uses vhost-user as interface with VM.
> +Note that number used in those tags should be the same value (e.g. chr0,sock0,vhost-net0) and these values should correspond to "add vhost N" (in this example 0).
> +MAC address used in ``<qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>`` can be specified when registering MAC address to classifier using Secondary command.
> +
> +        The following is an example of modified xml file:
> +
>   .. code-block:: xml
>   
>       <domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
> @@ -266,13 +299,13 @@ In this case, you should try it.
>   
>   .. code-block:: console
>   
> -    $ sudo ln -s /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper /etc/apparmor.d/disable/usr.lib.libvirt.virt-aa-helper
> -    $ sudo ln -s /etc/apparmor.d/usr.sbin.libvirtd /etc/apparmor.d/disable/usr.sbin.libvirtd
> -    $ sudo apparmor_parser -R /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper
> -    $ sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
> -    $ sudo service apparmor reload
> -    $ sudo service apparmor restart
> -    $ sudo service libvirt-bin restart
> +    #Edit /etc/libvirt/qemu.conf and set security_driver to none:
> +    $sudo vi /etc/libvirt/qemu.conf
> +    ...
> +    security_driver = "none"
> +    ...
> +    #Restart libvirtd:
> +    $sudo systemctl restart libvirtd.service
>   
>   Or, you remove appamor.
>   
> diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
> index b5256e5..6a4f62f 100644
> --- a/docs/guides/spp_vf/use_cases/usecase1.rst
> +++ b/docs/guides/spp_vf/use_cases/usecase1.rst
> @@ -186,6 +186,10 @@ In this usecase, you need to register two MAC addresses for merger1.
>       spp > sec 1;classifier_table add mac 52:54:00:12:34:56 ring:0
>       spp > sec 1;classifier_table add mac 52:54:00:12:34:58 ring:1
>   
> +.. note::
> +
> +    Please verify that MAC address of target VM is specified in
> +    [MACADDRESS] parameter.
>   
>   Configuration for the second login path is almost similar to the first
>   path.
> @@ -234,6 +238,11 @@ Register entries to classifier_table for classifier2.
>       spp > sec 1;classifier_table add mac 52:54:00:12:34:57 ring:4
>       spp > sec 1;classifier_table add mac 52:54:00:12:34:59 ring:5
>   
> +.. note::
> +
> +    Please verify that MAC address of target VM is specified in
> +    [MACADDRESS] parameter.
> +
>   Finally, activate all of settings by doign `flush` subcommand.
>   
>   .. code-block:: console
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v3 0/2] docs:fix error and improve document under spp_vf
  2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
@ 2018-05-16  8:49     ` x-fn-spp
  2018-05-17  4:00       ` Yasufumi Ogawa
                         ` (3 more replies)
  2018-05-16  8:49     ` [spp] [PATCH v3 1/2] docs: fix document error " x-fn-spp
  2018-05-16  8:49     ` [spp] [PATCH v3 2/2] docs: improve document " x-fn-spp
  2 siblings, 4 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-16  8:49 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

Hello Yasufumi-san,

I followed your guidance and made following changes on patch set:
  1.Additionally fix typo on "unmount" and add detailed descriptions about
    fixed errors in commit message in the first patch(0001). 
  2.Unify usage of VM_NAME.And also change description around virsh edit
    in the second patch(0002). 

BR,
Hideyuki Yamashita

Hideyuki-Yamashita (2):
  docs: fix document error under spp_vf directory
  docs: improve document under spp_vf directory

 docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
 docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
 2 files changed, 90 insertions(+), 52 deletions(-)

-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v3 1/2] docs: fix document error under spp_vf directory
  2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
@ 2018-05-16  8:49     ` x-fn-spp
  2018-05-16  8:49     ` [spp] [PATCH v3 2/2] docs: improve document " x-fn-spp
  2 siblings, 0 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-16  8:49 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

- Fix typo in build.rst
- Fix typo and error(listed in following) in usecase1.rst
    - Fix incorrect configuration. Coremask should be '0x3ffd', not '0x00fe'.
    - Fix many mistakes for assigning resource IDs while setting up spp_vf

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          |  6 +--
 docs/guides/spp_vf/use_cases/usecase1.rst | 80 +++++++++++++++----------------
 2 files changed, 42 insertions(+), 44 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index a37f86a..2ccbd15 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -79,7 +79,7 @@ You need to run ``update-grub`` and reboot to activate grub config.
 
 .. code-block:: console
 
-    $ sudo upadte-grub
+    $ sudo update-grub
     $ sudo reboot
 
 
@@ -101,11 +101,11 @@ You can check hugepage settings as following.
     hugetlbfs-kvm on /run/hugepages/kvm type hugetlbfs (rw,relatime,mode=775,gid=117)
     hugetlb on /run/lxcfs/controllers/hugetlb type cgroup (rw,relatime,hugetlb,release_agent=/run/cgmanager/agents/cgm-release-agent.hugetlb,nsroot=/)
 
-Finally, you unmount default hugepage.
+Finally, you umount default hugepage.
 
 .. code-block:: console
 
-    $ sudo unmount /dev/hugepages
+    $ sudo umount /dev/hugepages
 
 
 Install DPDK
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index 080aba1..b5256e5 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -82,7 +82,7 @@ After ``spp_primary`` is launched, run secondary process ``spp_vf``.
 .. code-block:: console
 
     $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
-        -c 0x00fe -n 4 --proc-type=secondary \
+        -c 0x3ffd -n 4 --proc-type=secondary \
         -- \
         --client-id 1 \
         -s 127.0.0.1:6666 \
@@ -156,14 +156,14 @@ merger has two rx ports.
     spp > sec 1;port add ring:0 rx forwarder1
     spp > sec 1;port add vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port add vhost:0 rx forwarder2
-    spp > sec 1;port add ring:2 tx forwarder2
+    spp > sec 1;port add ring:1 rx forwarder2
+    spp > sec 1;port add vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port add ring:1 rx forwarder3
-    spp > sec 1;port add vhost:2 rx forwarder3
+    spp > sec 1;port add vhost:0 rx forwarder3
+    spp > sec 1;port add ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port add vhost:2 tx forwarder4
-    spp > sec 1;port add ring:3 rx forwarder4
+    spp > sec 1;port add vhost:2 rx forwarder4
+    spp > sec 1;port add ring:3 tx forwarder4
     # merger1
     spp > sec 1;port add ring:2 rx merger1
     spp > sec 1;port add ring:3 rx merger1
@@ -213,14 +213,14 @@ Add ports to each of components.
     spp > sec 1;port add ring:4 rx forwarder5
     spp > sec 1;port add vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port add vhost:1 rx forwarder6
-    spp > sec 1;port add ring:6 tx forwarder6
+    spp > sec 1;port add ring:5 rx forwarder6
+    spp > sec 1;port add vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port add ring:5 rx forwarder7
-    spp > sec 1;port add vhost:3 rx forwarder7
+    spp > sec 1;port add vhost:1 rx forwarder7
+    spp > sec 1;port add ring:6 tx forwarder7
     # forwarder8
-    spp > sec 1;port add vhost:3 tx forwarder8
-    spp > sec 1;port add ring:7 rx forwarder8
+    spp > sec 1;port add vhost:3 rx forwarder8
+    spp > sec 1;port add ring:7 tx forwarder8
     # merger2
     spp > sec 1;port add ring:6 rx merger2
     spp > sec 1;port add ring:7 rx merger2
@@ -287,8 +287,6 @@ Configurations also for ``spp-vm2`` as ``spp-vm1``.
 
 .. code-block:: console
 
-    $ ssh -oStrictHostKeyChecking=no sppuser@192.168.122.32
-
     # up interfaces
     $ sudo ifconfig ens4 inet 192.168.140.31 netmask 255.255.255.0 up
     $ sudo ifconfig ens5 inet 192.168.150.32 netmask 255.255.255.0 up
@@ -340,21 +338,21 @@ for the first SSH login path.
     spp > sec 1;port del ring:0 tx classifier1
     spp > sec 1;port del ring:1 tx classifier1
     # forwarder1
-    spp > sec 1;port del ring:0 rx forward1
-    spp > sec 1;port del vhost:0 tx forward1
+    spp > sec 1;port del ring:0 rx forwarder1
+    spp > sec 1;port del vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port del vhost:0 rx forward2
-    spp > sec 1;port del ring:2 tx forward2
+    spp > sec 1;port del ring:1 rx forwarder2
+    spp > sec 1;port del vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port del ring:1 rx forward3
-    spp > sec 1;port del vhost:2 rx forward3
+    spp > sec 1;port del vhost:0 rx forwarder3
+    spp > sec 1;port del ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port del vhost:2 tx forward4
-    spp > sec 1;port del ring:3 rx forward4
+    spp > sec 1;port del vhost:2 rx forwarder4
+    spp > sec 1;port del ring:3 tx forwarder4
     # merger1
-    spp > sec 1;port del ring:2 rx merge1
-    spp > sec 1;port del ring:3 rx merge1
-    spp > sec 1;port del phy:0 tx merge1
+    spp > sec 1;port del ring:2 rx merger1
+    spp > sec 1;port del ring:3 rx merger1
+    spp > sec 1;port del phy:0 tx merger1
 
 Then, stop components.
 
@@ -362,11 +360,11 @@ Then, stop components.
 
     # Stop component to spp_vf
     spp > sec 1;component stop classifier1
-    spp > sec 1;component stop forward1
-    spp > sec 1;component stop forward2
-    spp > sec 1;component stop forward3
-    spp > sec 1;component stop forward4
-    spp > sec 1;component stop merge1
+    spp > sec 1;component stop forwarder1
+    spp > sec 1;component stop forwarder2
+    spp > sec 1;component stop forwarder3
+    spp > sec 1;component stop forwarder4
+    spp > sec 1;component stop merger1
 
 Second, do termination for the second path.
 Delete entries from ``classifier_table`` and ports from each of
@@ -388,11 +386,11 @@ components.
     spp > sec 1;port del ring:4 rx forwarder5
     spp > sec 1;port del vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port del vhost:1 rx forwarder6
-    spp > sec 1;port del ring:6 tx forwarder6
+    spp > sec 1;port del ring:5 rx forwarder6
+    spp > sec 1;port del vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port del ring:5 rx forwarder7
-    spp > sec 1;port del vhost:3 rx forwarder7
+    spp > sec 1;port del vhost:1 rx forwarder7
+    spp > sec 1;port del ring:6 tx forwarder7
     # forwarder8
     spp > sec 1;port del vhost:3 tx forwarder8
     spp > sec 1;port del ring:7 rx forwarder8
@@ -406,12 +404,12 @@ Then, stop components.
 .. code-block:: console
 
     # Stop component to spp_vf
-    spp > sec 1;component stop classifier2 8 classifier_mac
-    spp > sec 1;component stop forward5 9 forward
-    spp > sec 1;component stop forward6 10 forward
-    spp > sec 1;component stop forward7 11 forward
-    spp > sec 1;component stop forward8 12 forward
-    spp > sec 1;component stop merge2 13 merge
+    spp > sec 1;component stop classifier2
+    spp > sec 1;component stop forwarder5
+    spp > sec 1;component stop forwarder6
+    spp > sec 1;component stop forwarder7
+    spp > sec 1;component stop forwarder8
+    spp > sec 1;component stop merger2
 
 Finally, run ``flush`` subcommand.
 
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v3 2/2] docs: improve document under spp_vf directory
  2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
  2018-05-16  8:49     ` [spp] [PATCH v3 1/2] docs: fix document error " x-fn-spp
@ 2018-05-16  8:49     ` x-fn-spp
  2 siblings, 0 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-16  8:49 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

    - Add detail about where to edit using virsh edit command in build.rst
    - Change command in Trouble Shooting Guide in build.rst
    - Additional note when registering MAC address to classfier in usecase1.rst

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          | 47 +++++++++++++++++++++++++------
 docs/guides/spp_vf/use_cases/usecase1.rst |  9 ++++++
 2 files changed, 48 insertions(+), 8 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 2ccbd15..573d6be 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -30,7 +30,7 @@
 
 .. _spp_vf_gsg_build:
 
-Build
+Setup
 =====
 
 Environment
@@ -165,6 +165,30 @@ Then, bind it with PCI_Number.
 
 virsh setup
 -----------
+``virsh`` is a command line interface that can be used to create, destroy, stop start and edit VMs and configure. After create an image file, you can setup it with ``virt-install``.
+
+.. code-block:: console
+
+   virt-install \
+   --name [VM_NAME] \
+   --ram 4096 \
+   --disk path=/var/lib/libvirt/images/[VM_NAME].img,size=30 \
+   --vcpus 4 \
+   --os-type linux \
+   --os-variant ubuntu16.04 \
+   --network network=default \
+   --graphics none \
+   --console pty,target_type=serial \
+   --location 'http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/' \
+   --extra-args 'console=ttyS0,115200n8 serial'
+
+You may need type the following commands through ssh to activate console.
+
+.. code-block:: console
+
+    $sudo systemctl enable serial-getty@ttyS0.service
+    $sudo systemctl start serial-getty@ttyS0.service
+
 
 Edit VM configuration with virsh.
 
@@ -172,6 +196,13 @@ Edit VM configuration with virsh.
 
     $ virsh edit [VM_NAME]
 
+You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` into the domain tag because of adding ``<qemu:commandline>`` tag.
+In addition, you need to add the tag enclosed by ``<memoryBacking>`` and ``</memoryBacking>``, ``<qemu:commandline>`` and ``</qemu:commandline>`` because SPP uses vhost-user as interface with VM.
+Note that number used in those tags should be the same value (e.g. chr0,sock0,vhost-net0) and these values should correspond to "add vhost N" (in this example 0).
+MAC address used in ``<qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>`` can be specified when registering MAC address to classifier using Secondary command.
+
+        The following is an example of modified xml file:
+
 .. code-block:: xml
 
     <domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
@@ -266,13 +297,13 @@ In this case, you should try it.
 
 .. code-block:: console
 
-    $ sudo ln -s /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper /etc/apparmor.d/disable/usr.lib.libvirt.virt-aa-helper
-    $ sudo ln -s /etc/apparmor.d/usr.sbin.libvirtd /etc/apparmor.d/disable/usr.sbin.libvirtd
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
-    $ sudo service apparmor reload
-    $ sudo service apparmor restart
-    $ sudo service libvirt-bin restart
+    #Edit /etc/libvirt/qemu.conf and set security_driver to none:
+    $sudo vi /etc/libvirt/qemu.conf
+    ...
+    security_driver = "none"
+    ...
+    #Restart libvirtd:
+    $sudo systemctl restart libvirtd.service
 
 Or, you remove appamor.
 
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index b5256e5..6a4f62f 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -186,6 +186,10 @@ In this usecase, you need to register two MAC addresses for merger1.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:56 ring:0
     spp > sec 1;classifier_table add mac 52:54:00:12:34:58 ring:1
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
 
 Configuration for the second login path is almost similar to the first
 path.
@@ -234,6 +238,11 @@ Register entries to classifier_table for classifier2.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:57 ring:4
     spp > sec 1;classifier_table add mac 52:54:00:12:34:59 ring:5
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
+
 Finally, activate all of settings by doign `flush` subcommand.
 
 .. code-block:: console
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [spp] [PATCH v3 0/2] docs:fix error and improve document under spp_vf
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
@ 2018-05-17  4:00       ` Yasufumi Ogawa
  2018-05-17  6:41       ` [spp] [PATCH v4 " x-fn-spp
                         ` (2 subsequent siblings)
  3 siblings, 0 replies; 19+ messages in thread
From: Yasufumi Ogawa @ 2018-05-17  4:00 UTC (permalink / raw)
  To: x-fn-spp; +Cc: ferruh.yigit, spp

On 2018/05/16 17:49, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> 
> Hello Yasufumi-san,
> 
> I followed your guidance and made following changes on patch set:
>    1.Additionally fix typo on "unmount" and add detailed descriptions about
>      fixed errors in commit message in the first patch(0001).
>    2.Unify usage of VM_NAME.And also change description around virsh edit
>      in the second patch(0002).
> 
Thank you for revising your patches. However, commit messages of both of patches are too long.

It is noticed that "commit message should be wrapped at 72 characters" in DPDK's contribution guide, or warned from 
dpdk/devtools/checkpatches.sh if it is over 75 chars. Basically, SPP is following with DPDK's guide.
> BR,
> Hideyuki Yamashita
> 
> Hideyuki-Yamashita (2):
>    docs: fix document error under spp_vf directory
>    docs: improve document under spp_vf directory
> 
>   docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
>   docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
>   2 files changed, 90 insertions(+), 52 deletions(-)
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v4 0/2] docs:fix error and improve document under spp_vf
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
  2018-05-17  4:00       ` Yasufumi Ogawa
@ 2018-05-17  6:41       ` x-fn-spp
  2018-05-17  8:18         ` [spp] [PATCH v5 " x-fn-spp
                           ` (2 more replies)
  2018-05-17  6:41       ` [spp] [PATCH v4 1/2] docs: fix document error " x-fn-spp
  2018-05-17  6:41       ` [spp] [PATCH v4 2/2] docs: improve document " x-fn-spp
  3 siblings, 3 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-17  6:41 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

Hello Yasufumi-san,

Following your guidance, I shortened commit message length in both patches.

In summary, what those patches contain are following:
1st patch:
  - Fix typo in build.rst
  - Fix typo and error(listed in following) in usecase1.rst
    - Fix incorrect configuration. Coremask should be '0x3ffd', not '0x00fe'.
    - Fix many mistakes for assigning resource IDs while setting up spp_vf
2nd patch:
    - Add detail about where to edit using virsh edit command in build.rst
    - Change command in Trouble Shooting Guide in build.rst
    - Additional note when registering MAC address to classfier in usecase1.rst

Hideyuki-Yamashita (2):
  docs: fix document error under spp_vf directory
  docs: improve document under spp_vf directory

 docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
 docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
 2 files changed, 90 insertions(+), 52 deletions(-)

-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v4 1/2] docs: fix document error under spp_vf directory
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
  2018-05-17  4:00       ` Yasufumi Ogawa
  2018-05-17  6:41       ` [spp] [PATCH v4 " x-fn-spp
@ 2018-05-17  6:41       ` x-fn-spp
  2018-05-17  6:41       ` [spp] [PATCH v4 2/2] docs: improve document " x-fn-spp
  3 siblings, 0 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-17  6:41 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

This patch fixes document error under spp_vf directory.

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          |  6 +--
 docs/guides/spp_vf/use_cases/usecase1.rst | 80 +++++++++++++++----------------
 2 files changed, 42 insertions(+), 44 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index a37f86a..2ccbd15 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -79,7 +79,7 @@ You need to run ``update-grub`` and reboot to activate grub config.
 
 .. code-block:: console
 
-    $ sudo upadte-grub
+    $ sudo update-grub
     $ sudo reboot
 
 
@@ -101,11 +101,11 @@ You can check hugepage settings as following.
     hugetlbfs-kvm on /run/hugepages/kvm type hugetlbfs (rw,relatime,mode=775,gid=117)
     hugetlb on /run/lxcfs/controllers/hugetlb type cgroup (rw,relatime,hugetlb,release_agent=/run/cgmanager/agents/cgm-release-agent.hugetlb,nsroot=/)
 
-Finally, you unmount default hugepage.
+Finally, you umount default hugepage.
 
 .. code-block:: console
 
-    $ sudo unmount /dev/hugepages
+    $ sudo umount /dev/hugepages
 
 
 Install DPDK
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index 080aba1..b5256e5 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -82,7 +82,7 @@ After ``spp_primary`` is launched, run secondary process ``spp_vf``.
 .. code-block:: console
 
     $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
-        -c 0x00fe -n 4 --proc-type=secondary \
+        -c 0x3ffd -n 4 --proc-type=secondary \
         -- \
         --client-id 1 \
         -s 127.0.0.1:6666 \
@@ -156,14 +156,14 @@ merger has two rx ports.
     spp > sec 1;port add ring:0 rx forwarder1
     spp > sec 1;port add vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port add vhost:0 rx forwarder2
-    spp > sec 1;port add ring:2 tx forwarder2
+    spp > sec 1;port add ring:1 rx forwarder2
+    spp > sec 1;port add vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port add ring:1 rx forwarder3
-    spp > sec 1;port add vhost:2 rx forwarder3
+    spp > sec 1;port add vhost:0 rx forwarder3
+    spp > sec 1;port add ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port add vhost:2 tx forwarder4
-    spp > sec 1;port add ring:3 rx forwarder4
+    spp > sec 1;port add vhost:2 rx forwarder4
+    spp > sec 1;port add ring:3 tx forwarder4
     # merger1
     spp > sec 1;port add ring:2 rx merger1
     spp > sec 1;port add ring:3 rx merger1
@@ -213,14 +213,14 @@ Add ports to each of components.
     spp > sec 1;port add ring:4 rx forwarder5
     spp > sec 1;port add vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port add vhost:1 rx forwarder6
-    spp > sec 1;port add ring:6 tx forwarder6
+    spp > sec 1;port add ring:5 rx forwarder6
+    spp > sec 1;port add vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port add ring:5 rx forwarder7
-    spp > sec 1;port add vhost:3 rx forwarder7
+    spp > sec 1;port add vhost:1 rx forwarder7
+    spp > sec 1;port add ring:6 tx forwarder7
     # forwarder8
-    spp > sec 1;port add vhost:3 tx forwarder8
-    spp > sec 1;port add ring:7 rx forwarder8
+    spp > sec 1;port add vhost:3 rx forwarder8
+    spp > sec 1;port add ring:7 tx forwarder8
     # merger2
     spp > sec 1;port add ring:6 rx merger2
     spp > sec 1;port add ring:7 rx merger2
@@ -287,8 +287,6 @@ Configurations also for ``spp-vm2`` as ``spp-vm1``.
 
 .. code-block:: console
 
-    $ ssh -oStrictHostKeyChecking=no sppuser@192.168.122.32
-
     # up interfaces
     $ sudo ifconfig ens4 inet 192.168.140.31 netmask 255.255.255.0 up
     $ sudo ifconfig ens5 inet 192.168.150.32 netmask 255.255.255.0 up
@@ -340,21 +338,21 @@ for the first SSH login path.
     spp > sec 1;port del ring:0 tx classifier1
     spp > sec 1;port del ring:1 tx classifier1
     # forwarder1
-    spp > sec 1;port del ring:0 rx forward1
-    spp > sec 1;port del vhost:0 tx forward1
+    spp > sec 1;port del ring:0 rx forwarder1
+    spp > sec 1;port del vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port del vhost:0 rx forward2
-    spp > sec 1;port del ring:2 tx forward2
+    spp > sec 1;port del ring:1 rx forwarder2
+    spp > sec 1;port del vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port del ring:1 rx forward3
-    spp > sec 1;port del vhost:2 rx forward3
+    spp > sec 1;port del vhost:0 rx forwarder3
+    spp > sec 1;port del ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port del vhost:2 tx forward4
-    spp > sec 1;port del ring:3 rx forward4
+    spp > sec 1;port del vhost:2 rx forwarder4
+    spp > sec 1;port del ring:3 tx forwarder4
     # merger1
-    spp > sec 1;port del ring:2 rx merge1
-    spp > sec 1;port del ring:3 rx merge1
-    spp > sec 1;port del phy:0 tx merge1
+    spp > sec 1;port del ring:2 rx merger1
+    spp > sec 1;port del ring:3 rx merger1
+    spp > sec 1;port del phy:0 tx merger1
 
 Then, stop components.
 
@@ -362,11 +360,11 @@ Then, stop components.
 
     # Stop component to spp_vf
     spp > sec 1;component stop classifier1
-    spp > sec 1;component stop forward1
-    spp > sec 1;component stop forward2
-    spp > sec 1;component stop forward3
-    spp > sec 1;component stop forward4
-    spp > sec 1;component stop merge1
+    spp > sec 1;component stop forwarder1
+    spp > sec 1;component stop forwarder2
+    spp > sec 1;component stop forwarder3
+    spp > sec 1;component stop forwarder4
+    spp > sec 1;component stop merger1
 
 Second, do termination for the second path.
 Delete entries from ``classifier_table`` and ports from each of
@@ -388,11 +386,11 @@ components.
     spp > sec 1;port del ring:4 rx forwarder5
     spp > sec 1;port del vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port del vhost:1 rx forwarder6
-    spp > sec 1;port del ring:6 tx forwarder6
+    spp > sec 1;port del ring:5 rx forwarder6
+    spp > sec 1;port del vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port del ring:5 rx forwarder7
-    spp > sec 1;port del vhost:3 rx forwarder7
+    spp > sec 1;port del vhost:1 rx forwarder7
+    spp > sec 1;port del ring:6 tx forwarder7
     # forwarder8
     spp > sec 1;port del vhost:3 tx forwarder8
     spp > sec 1;port del ring:7 rx forwarder8
@@ -406,12 +404,12 @@ Then, stop components.
 .. code-block:: console
 
     # Stop component to spp_vf
-    spp > sec 1;component stop classifier2 8 classifier_mac
-    spp > sec 1;component stop forward5 9 forward
-    spp > sec 1;component stop forward6 10 forward
-    spp > sec 1;component stop forward7 11 forward
-    spp > sec 1;component stop forward8 12 forward
-    spp > sec 1;component stop merge2 13 merge
+    spp > sec 1;component stop classifier2
+    spp > sec 1;component stop forwarder5
+    spp > sec 1;component stop forwarder6
+    spp > sec 1;component stop forwarder7
+    spp > sec 1;component stop forwarder8
+    spp > sec 1;component stop merger2
 
 Finally, run ``flush`` subcommand.
 
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v4 2/2] docs: improve document under spp_vf directory
  2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
                         ` (2 preceding siblings ...)
  2018-05-17  6:41       ` [spp] [PATCH v4 1/2] docs: fix document error " x-fn-spp
@ 2018-05-17  6:41       ` x-fn-spp
  3 siblings, 0 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-17  6:41 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

This patch improves document under spp_vf directory.

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          | 47 +++++++++++++++++++++++++------
 docs/guides/spp_vf/use_cases/usecase1.rst |  9 ++++++
 2 files changed, 48 insertions(+), 8 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 2ccbd15..573d6be 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -30,7 +30,7 @@
 
 .. _spp_vf_gsg_build:
 
-Build
+Setup
 =====
 
 Environment
@@ -165,6 +165,30 @@ Then, bind it with PCI_Number.
 
 virsh setup
 -----------
+``virsh`` is a command line interface that can be used to create, destroy, stop start and edit VMs and configure. After create an image file, you can setup it with ``virt-install``.
+
+.. code-block:: console
+
+   virt-install \
+   --name [VM_NAME] \
+   --ram 4096 \
+   --disk path=/var/lib/libvirt/images/[VM_NAME].img,size=30 \
+   --vcpus 4 \
+   --os-type linux \
+   --os-variant ubuntu16.04 \
+   --network network=default \
+   --graphics none \
+   --console pty,target_type=serial \
+   --location 'http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/' \
+   --extra-args 'console=ttyS0,115200n8 serial'
+
+You may need type the following commands through ssh to activate console.
+
+.. code-block:: console
+
+    $sudo systemctl enable serial-getty@ttyS0.service
+    $sudo systemctl start serial-getty@ttyS0.service
+
 
 Edit VM configuration with virsh.
 
@@ -172,6 +196,13 @@ Edit VM configuration with virsh.
 
     $ virsh edit [VM_NAME]
 
+You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` into the domain tag because of adding ``<qemu:commandline>`` tag.
+In addition, you need to add the tag enclosed by ``<memoryBacking>`` and ``</memoryBacking>``, ``<qemu:commandline>`` and ``</qemu:commandline>`` because SPP uses vhost-user as interface with VM.
+Note that number used in those tags should be the same value (e.g. chr0,sock0,vhost-net0) and these values should correspond to "add vhost N" (in this example 0).
+MAC address used in ``<qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>`` can be specified when registering MAC address to classifier using Secondary command.
+
+        The following is an example of modified xml file:
+
 .. code-block:: xml
 
     <domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
@@ -266,13 +297,13 @@ In this case, you should try it.
 
 .. code-block:: console
 
-    $ sudo ln -s /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper /etc/apparmor.d/disable/usr.lib.libvirt.virt-aa-helper
-    $ sudo ln -s /etc/apparmor.d/usr.sbin.libvirtd /etc/apparmor.d/disable/usr.sbin.libvirtd
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
-    $ sudo service apparmor reload
-    $ sudo service apparmor restart
-    $ sudo service libvirt-bin restart
+    #Edit /etc/libvirt/qemu.conf and set security_driver to none:
+    $sudo vi /etc/libvirt/qemu.conf
+    ...
+    security_driver = "none"
+    ...
+    #Restart libvirtd:
+    $sudo systemctl restart libvirtd.service
 
 Or, you remove appamor.
 
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index b5256e5..6a4f62f 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -186,6 +186,10 @@ In this usecase, you need to register two MAC addresses for merger1.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:56 ring:0
     spp > sec 1;classifier_table add mac 52:54:00:12:34:58 ring:1
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
 
 Configuration for the second login path is almost similar to the first
 path.
@@ -234,6 +238,11 @@ Register entries to classifier_table for classifier2.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:57 ring:4
     spp > sec 1;classifier_table add mac 52:54:00:12:34:59 ring:5
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
+
 Finally, activate all of settings by doign `flush` subcommand.
 
 .. code-block:: console
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v5 0/2] docs:fix error and improve document under spp_vf
  2018-05-17  6:41       ` [spp] [PATCH v4 " x-fn-spp
@ 2018-05-17  8:18         ` x-fn-spp
  2018-05-17  9:46           ` Yasufumi Ogawa
  2018-05-17  8:18         ` [spp] [PATCH v5 1/2] docs: fix document error under spp_vf directory x-fn-spp
  2018-05-17  8:18         ` [spp] [PATCH v5 2/2] docs: improve document " x-fn-spp
  2 siblings, 1 reply; 19+ messages in thread
From: x-fn-spp @ 2018-05-17  8:18 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

Hello Yasufumi-san,
In v4 patch set I shortened the content too much.
The important thing is "commit message should be wrapped at 72 characters".

So I reverted commit message with proper wrapping.

The purpose of these patch is the same with the original
(fix and improve document related to spp_vf).

BR,
Hideyuki Yamashita

Hideyuki-Yamashita (2):
  docs: fix document error under spp_vf directory
  docs: improve document under spp_vf directory

 docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
 docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
 2 files changed, 90 insertions(+), 52 deletions(-)

-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v5 1/2] docs: fix document error under spp_vf directory
  2018-05-17  6:41       ` [spp] [PATCH v4 " x-fn-spp
  2018-05-17  8:18         ` [spp] [PATCH v5 " x-fn-spp
@ 2018-05-17  8:18         ` x-fn-spp
  2018-05-17  8:18         ` [spp] [PATCH v5 2/2] docs: improve document " x-fn-spp
  2 siblings, 0 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-17  8:18 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

- Fix typo in build.rst
- Fix typo and error(listed in following) in usecase1.rst
    - Fix incorrect configuration. Coremask should be '0x3ffd', not
	'0x00fe'.
    - Fix many mistakes for assigning resource IDs while setting up
	 spp_vf.

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          |  6 +--
 docs/guides/spp_vf/use_cases/usecase1.rst | 80 +++++++++++++++----------------
 2 files changed, 42 insertions(+), 44 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index a37f86a..2ccbd15 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -79,7 +79,7 @@ You need to run ``update-grub`` and reboot to activate grub config.
 
 .. code-block:: console
 
-    $ sudo upadte-grub
+    $ sudo update-grub
     $ sudo reboot
 
 
@@ -101,11 +101,11 @@ You can check hugepage settings as following.
     hugetlbfs-kvm on /run/hugepages/kvm type hugetlbfs (rw,relatime,mode=775,gid=117)
     hugetlb on /run/lxcfs/controllers/hugetlb type cgroup (rw,relatime,hugetlb,release_agent=/run/cgmanager/agents/cgm-release-agent.hugetlb,nsroot=/)
 
-Finally, you unmount default hugepage.
+Finally, you umount default hugepage.
 
 .. code-block:: console
 
-    $ sudo unmount /dev/hugepages
+    $ sudo umount /dev/hugepages
 
 
 Install DPDK
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index 080aba1..b5256e5 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -82,7 +82,7 @@ After ``spp_primary`` is launched, run secondary process ``spp_vf``.
 .. code-block:: console
 
     $ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
-        -c 0x00fe -n 4 --proc-type=secondary \
+        -c 0x3ffd -n 4 --proc-type=secondary \
         -- \
         --client-id 1 \
         -s 127.0.0.1:6666 \
@@ -156,14 +156,14 @@ merger has two rx ports.
     spp > sec 1;port add ring:0 rx forwarder1
     spp > sec 1;port add vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port add vhost:0 rx forwarder2
-    spp > sec 1;port add ring:2 tx forwarder2
+    spp > sec 1;port add ring:1 rx forwarder2
+    spp > sec 1;port add vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port add ring:1 rx forwarder3
-    spp > sec 1;port add vhost:2 rx forwarder3
+    spp > sec 1;port add vhost:0 rx forwarder3
+    spp > sec 1;port add ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port add vhost:2 tx forwarder4
-    spp > sec 1;port add ring:3 rx forwarder4
+    spp > sec 1;port add vhost:2 rx forwarder4
+    spp > sec 1;port add ring:3 tx forwarder4
     # merger1
     spp > sec 1;port add ring:2 rx merger1
     spp > sec 1;port add ring:3 rx merger1
@@ -213,14 +213,14 @@ Add ports to each of components.
     spp > sec 1;port add ring:4 rx forwarder5
     spp > sec 1;port add vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port add vhost:1 rx forwarder6
-    spp > sec 1;port add ring:6 tx forwarder6
+    spp > sec 1;port add ring:5 rx forwarder6
+    spp > sec 1;port add vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port add ring:5 rx forwarder7
-    spp > sec 1;port add vhost:3 rx forwarder7
+    spp > sec 1;port add vhost:1 rx forwarder7
+    spp > sec 1;port add ring:6 tx forwarder7
     # forwarder8
-    spp > sec 1;port add vhost:3 tx forwarder8
-    spp > sec 1;port add ring:7 rx forwarder8
+    spp > sec 1;port add vhost:3 rx forwarder8
+    spp > sec 1;port add ring:7 tx forwarder8
     # merger2
     spp > sec 1;port add ring:6 rx merger2
     spp > sec 1;port add ring:7 rx merger2
@@ -287,8 +287,6 @@ Configurations also for ``spp-vm2`` as ``spp-vm1``.
 
 .. code-block:: console
 
-    $ ssh -oStrictHostKeyChecking=no sppuser@192.168.122.32
-
     # up interfaces
     $ sudo ifconfig ens4 inet 192.168.140.31 netmask 255.255.255.0 up
     $ sudo ifconfig ens5 inet 192.168.150.32 netmask 255.255.255.0 up
@@ -340,21 +338,21 @@ for the first SSH login path.
     spp > sec 1;port del ring:0 tx classifier1
     spp > sec 1;port del ring:1 tx classifier1
     # forwarder1
-    spp > sec 1;port del ring:0 rx forward1
-    spp > sec 1;port del vhost:0 tx forward1
+    spp > sec 1;port del ring:0 rx forwarder1
+    spp > sec 1;port del vhost:0 tx forwarder1
     # forwarder2
-    spp > sec 1;port del vhost:0 rx forward2
-    spp > sec 1;port del ring:2 tx forward2
+    spp > sec 1;port del ring:1 rx forwarder2
+    spp > sec 1;port del vhost:2 tx forwarder2
     # forwarder3
-    spp > sec 1;port del ring:1 rx forward3
-    spp > sec 1;port del vhost:2 rx forward3
+    spp > sec 1;port del vhost:0 rx forwarder3
+    spp > sec 1;port del ring:2 tx forwarder3
     # forwarder4
-    spp > sec 1;port del vhost:2 tx forward4
-    spp > sec 1;port del ring:3 rx forward4
+    spp > sec 1;port del vhost:2 rx forwarder4
+    spp > sec 1;port del ring:3 tx forwarder4
     # merger1
-    spp > sec 1;port del ring:2 rx merge1
-    spp > sec 1;port del ring:3 rx merge1
-    spp > sec 1;port del phy:0 tx merge1
+    spp > sec 1;port del ring:2 rx merger1
+    spp > sec 1;port del ring:3 rx merger1
+    spp > sec 1;port del phy:0 tx merger1
 
 Then, stop components.
 
@@ -362,11 +360,11 @@ Then, stop components.
 
     # Stop component to spp_vf
     spp > sec 1;component stop classifier1
-    spp > sec 1;component stop forward1
-    spp > sec 1;component stop forward2
-    spp > sec 1;component stop forward3
-    spp > sec 1;component stop forward4
-    spp > sec 1;component stop merge1
+    spp > sec 1;component stop forwarder1
+    spp > sec 1;component stop forwarder2
+    spp > sec 1;component stop forwarder3
+    spp > sec 1;component stop forwarder4
+    spp > sec 1;component stop merger1
 
 Second, do termination for the second path.
 Delete entries from ``classifier_table`` and ports from each of
@@ -388,11 +386,11 @@ components.
     spp > sec 1;port del ring:4 rx forwarder5
     spp > sec 1;port del vhost:1 tx forwarder5
     # forwarder6
-    spp > sec 1;port del vhost:1 rx forwarder6
-    spp > sec 1;port del ring:6 tx forwarder6
+    spp > sec 1;port del ring:5 rx forwarder6
+    spp > sec 1;port del vhost:3 tx forwarder6
     # forwarder7
-    spp > sec 1;port del ring:5 rx forwarder7
-    spp > sec 1;port del vhost:3 rx forwarder7
+    spp > sec 1;port del vhost:1 rx forwarder7
+    spp > sec 1;port del ring:6 tx forwarder7
     # forwarder8
     spp > sec 1;port del vhost:3 tx forwarder8
     spp > sec 1;port del ring:7 rx forwarder8
@@ -406,12 +404,12 @@ Then, stop components.
 .. code-block:: console
 
     # Stop component to spp_vf
-    spp > sec 1;component stop classifier2 8 classifier_mac
-    spp > sec 1;component stop forward5 9 forward
-    spp > sec 1;component stop forward6 10 forward
-    spp > sec 1;component stop forward7 11 forward
-    spp > sec 1;component stop forward8 12 forward
-    spp > sec 1;component stop merge2 13 merge
+    spp > sec 1;component stop classifier2
+    spp > sec 1;component stop forwarder5
+    spp > sec 1;component stop forwarder6
+    spp > sec 1;component stop forwarder7
+    spp > sec 1;component stop forwarder8
+    spp > sec 1;component stop merger2
 
 Finally, run ``flush`` subcommand.
 
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* [spp] [PATCH v5 2/2] docs: improve document under spp_vf directory
  2018-05-17  6:41       ` [spp] [PATCH v4 " x-fn-spp
  2018-05-17  8:18         ` [spp] [PATCH v5 " x-fn-spp
  2018-05-17  8:18         ` [spp] [PATCH v5 1/2] docs: fix document error under spp_vf directory x-fn-spp
@ 2018-05-17  8:18         ` x-fn-spp
  2 siblings, 0 replies; 19+ messages in thread
From: x-fn-spp @ 2018-05-17  8:18 UTC (permalink / raw)
  To: ferruh.yigit, ogawa.yasufumi; +Cc: spp

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

- Add detail about where to edit using virsh edit command in build.rst
- Change command in Trouble Shooting Guide in build.rst
- Additional note when registering MAC address to classfier in
usecase1.rst

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          | 47 +++++++++++++++++++++++++------
 docs/guides/spp_vf/use_cases/usecase1.rst |  9 ++++++
 2 files changed, 48 insertions(+), 8 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 2ccbd15..573d6be 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -30,7 +30,7 @@
 
 .. _spp_vf_gsg_build:
 
-Build
+Setup
 =====
 
 Environment
@@ -165,6 +165,30 @@ Then, bind it with PCI_Number.
 
 virsh setup
 -----------
+``virsh`` is a command line interface that can be used to create, destroy, stop start and edit VMs and configure. After create an image file, you can setup it with ``virt-install``.
+
+.. code-block:: console
+
+   virt-install \
+   --name [VM_NAME] \
+   --ram 4096 \
+   --disk path=/var/lib/libvirt/images/[VM_NAME].img,size=30 \
+   --vcpus 4 \
+   --os-type linux \
+   --os-variant ubuntu16.04 \
+   --network network=default \
+   --graphics none \
+   --console pty,target_type=serial \
+   --location 'http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/' \
+   --extra-args 'console=ttyS0,115200n8 serial'
+
+You may need type the following commands through ssh to activate console.
+
+.. code-block:: console
+
+    $sudo systemctl enable serial-getty@ttyS0.service
+    $sudo systemctl start serial-getty@ttyS0.service
+
 
 Edit VM configuration with virsh.
 
@@ -172,6 +196,13 @@ Edit VM configuration with virsh.
 
     $ virsh edit [VM_NAME]
 
+You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` into the domain tag because of adding ``<qemu:commandline>`` tag.
+In addition, you need to add the tag enclosed by ``<memoryBacking>`` and ``</memoryBacking>``, ``<qemu:commandline>`` and ``</qemu:commandline>`` because SPP uses vhost-user as interface with VM.
+Note that number used in those tags should be the same value (e.g. chr0,sock0,vhost-net0) and these values should correspond to "add vhost N" (in this example 0).
+MAC address used in ``<qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>`` can be specified when registering MAC address to classifier using Secondary command.
+
+        The following is an example of modified xml file:
+
 .. code-block:: xml
 
     <domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
@@ -266,13 +297,13 @@ In this case, you should try it.
 
 .. code-block:: console
 
-    $ sudo ln -s /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper /etc/apparmor.d/disable/usr.lib.libvirt.virt-aa-helper
-    $ sudo ln -s /etc/apparmor.d/usr.sbin.libvirtd /etc/apparmor.d/disable/usr.sbin.libvirtd
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
-    $ sudo service apparmor reload
-    $ sudo service apparmor restart
-    $ sudo service libvirt-bin restart
+    #Edit /etc/libvirt/qemu.conf and set security_driver to none:
+    $sudo vi /etc/libvirt/qemu.conf
+    ...
+    security_driver = "none"
+    ...
+    #Restart libvirtd:
+    $sudo systemctl restart libvirtd.service
 
 Or, you remove appamor.
 
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index b5256e5..6a4f62f 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -186,6 +186,10 @@ In this usecase, you need to register two MAC addresses for merger1.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:56 ring:0
     spp > sec 1;classifier_table add mac 52:54:00:12:34:58 ring:1
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
 
 Configuration for the second login path is almost similar to the first
 path.
@@ -234,6 +238,11 @@ Register entries to classifier_table for classifier2.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:57 ring:4
     spp > sec 1;classifier_table add mac 52:54:00:12:34:59 ring:5
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
+
 Finally, activate all of settings by doign `flush` subcommand.
 
 .. code-block:: console
-- 
1.9.1

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [spp] [PATCH v5 0/2] docs:fix error and improve document under spp_vf
  2018-05-17  8:18         ` [spp] [PATCH v5 " x-fn-spp
@ 2018-05-17  9:46           ` Yasufumi Ogawa
  2018-05-24 12:54             ` Ferruh Yigit
  0 siblings, 1 reply; 19+ messages in thread
From: Yasufumi Ogawa @ 2018-05-17  9:46 UTC (permalink / raw)
  To: x-fn-spp, ferruh.yigit; +Cc: spp

On 2018/05/17 17:18, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
> 
> Hello Yasufumi-san,
> In v4 patch set I shortened the content too much.
> The important thing is "commit message should be wrapped at 72 characters".
> 
> So I reverted commit message with proper wrapping.
> 
> The purpose of these patch is the same with the original
> (fix and improve document related to spp_vf).
> 
> BR,
> Hideyuki Yamashita
> 
> Hideyuki-Yamashita (2):
>    docs: fix document error under spp_vf directory
>    docs: improve document under spp_vf directory
I confirmed that both of your patches are merged without any problem. Your update will be helpful for users. Thanks!

Acked-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> 
>   docs/guides/spp_vf/gsg/build.rst          | 53 ++++++++++++++----
>   docs/guides/spp_vf/use_cases/usecase1.rst | 89 +++++++++++++++++--------------
>   2 files changed, 90 insertions(+), 52 deletions(-)
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [spp] [PATCH v5 0/2] docs:fix error and improve document under spp_vf
  2018-05-17  9:46           ` Yasufumi Ogawa
@ 2018-05-24 12:54             ` Ferruh Yigit
  0 siblings, 0 replies; 19+ messages in thread
From: Ferruh Yigit @ 2018-05-24 12:54 UTC (permalink / raw)
  To: Yasufumi Ogawa, x-fn-spp; +Cc: spp

On 5/17/2018 10:46 AM, Yasufumi Ogawa wrote:
> On 2018/05/17 17:18, x-fn-spp@sl.ntt-tx.co.jp wrote:
>> From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
>>
>> Hello Yasufumi-san,
>> In v4 patch set I shortened the content too much.
>> The important thing is "commit message should be wrapped at 72 characters".
>>
>> So I reverted commit message with proper wrapping.
>>
>> The purpose of these patch is the same with the original
>> (fix and improve document related to spp_vf).
>>
>> BR,
>> Hideyuki Yamashita
>>
>> Hideyuki-Yamashita (2):
>>    docs: fix document error under spp_vf directory
>>    docs: improve document under spp_vf directory
> I confirmed that both of your patches are merged without any problem. Your update will be helpful for users. Thanks!
> 
> Acked-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

Series applied, thanks.


In author name "-" removed: s/Hideyuki-Yamashita/Hideyuki Yamashita/

^ permalink raw reply	[flat|nested] 19+ messages in thread

end of thread, other threads:[~2018-05-24 12:54 UTC | newest]

Thread overview: 19+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-05-09  5:43 [spp] [PATCH 0/2] doc:Fix error and improve document under spp_vf x-fn-spp
2018-05-09  6:33 ` Yasufumi Ogawa
2018-05-09  6:57   ` [spp] [PATCH v2 0/2] doc:fix " x-fn-spp
2018-05-16  8:49     ` [spp] [PATCH v3 0/2] docs:fix " x-fn-spp
2018-05-17  4:00       ` Yasufumi Ogawa
2018-05-17  6:41       ` [spp] [PATCH v4 " x-fn-spp
2018-05-17  8:18         ` [spp] [PATCH v5 " x-fn-spp
2018-05-17  9:46           ` Yasufumi Ogawa
2018-05-24 12:54             ` Ferruh Yigit
2018-05-17  8:18         ` [spp] [PATCH v5 1/2] docs: fix document error under spp_vf directory x-fn-spp
2018-05-17  8:18         ` [spp] [PATCH v5 2/2] docs: improve document " x-fn-spp
2018-05-17  6:41       ` [spp] [PATCH v4 1/2] docs: fix document error " x-fn-spp
2018-05-17  6:41       ` [spp] [PATCH v4 2/2] docs: improve document " x-fn-spp
2018-05-16  8:49     ` [spp] [PATCH v3 1/2] docs: fix document error " x-fn-spp
2018-05-16  8:49     ` [spp] [PATCH v3 2/2] docs: improve document " x-fn-spp
2018-05-09  6:58   ` [spp] [PATCH v2 1/2] docs: fix document error " x-fn-spp
2018-05-11  3:44     ` Yasufumi Ogawa
2018-05-09  6:58   ` [spp] [PATCH v2 2/2] docs: improve document " x-fn-spp
2018-05-11  4:23     ` Yasufumi Ogawa

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).