[dts] [PATCH V2] test_plans: add test plan for vhost pvp performance test case based on qemu

["lei,yao" <lei.a.yao@intel.com>]

From: lei yao <lei.a.yao@intel.com>

Signed-off-by: lei yao <lei.a.yao@intel.com>
---
 .../vhost_qemu_pvp_performance_test_plan.rst       | 174 +++++++++++++++++++++
 1 file changed, 174 insertions(+)
 create mode 100644 test_plans/vhost_qemu_pvp_performance_test_plan.rst

diff --git a/test_plans/vhost_qemu_pvp_performance_test_plan.rst b/test_plans/vhost_qemu_pvp_performance_test_plan.rst
new file mode 100644
index 0000000..d68aa64
--- /dev/null
+++ b/test_plans/vhost_qemu_pvp_performance_test_plan.rst
@@ -0,0 +1,174 @@
+.. Copyright (c) <2016>, Intel Corporation
+   All rights reserved.
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions
+   are met:
+
+   - Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+
+   - Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in
+     the documentation and/or other materials provided with the
+     distribution.
+
+   - Neither the name of Intel Corporation nor the names of its
+     contributors may be used to endorse or promote products derived
+     from this software without specific prior written permission.
+
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+   COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+   OF THE POSSIBILITY OF SUCH DAMAGE.
+
+===========================================
+DPDK Vhost Qemu pvp performance test plan
+===========================================
+
+This test plan will cover the PVP performance test cases based on qemu settings
+
+Test Case 1: DPDK PVP performance on mergeable path
+===================================================
+
+Flow: 
+TG(Traffic generator) --> NIC --> Vhost --> Virtio--> Vhost--> NIC--> TG
+
+On host:
+
+1. First build the vhost-switch sample. 
+
+2. Start up vhost-switch, mergeable 1 means the jubmo frame feature is 
+enabled. vm2vm 0 means only one vm without vm2vm communication. Use 3core
+to launch the sample will get the best performance, 2 core will be used for 
+data path, one core is master core for some configuration.::
+
+    taskset -c 18-20 ./vhost-switch -c 0x1c0000 -n 4 \
+    --huge-dir /mnt/huge --socket-mem 1024,1024 \
+    -- -p 0x1 --mergeable 1 --vm2vm 0 --socket-file ./vhost-net
+   
+
+3. Start VM with vhost-user as backend, add 1 virtio devices::
+ 
+    taskset -c 22-26 \
+    qemu-system-x86_64 -name vm1 -cpu host -enable-kvm -m 2048 \
+     -object memory-backend-file,id=mem,size=2048M,mem-path=/mnt/huge,share=on \
+     -numa node,memdev=mem -mem-prealloc \
+     -smp cores=5,sockets=1 -drive file=/home/osimg/f23_liu.img  \
+     -chardev socket,id=char0,path=./vhost-net \
+     -netdev type=vhost-user,id=mynet1,chardev=char0,vhostforce,queues=1 \
+     -device virtio-net-pci,mac=52:54:00:00:00:01,netdev=mynet1,mrg_rxbuf=on,mq=on \
+     -netdev tap,id=ipvm1,ifname=tap4,script=/etc/qemu-ifup \
+     -device rtl8139,netdev=ipvm1,id=net0,mac=00:00:00:00:10:01 -vnc :10 -daemonize
+   
+
+4. On VM1, ensure the same dpdk folder is copied and run testpmd, virtio 
+device is binded to igb_uio, use ::
+    ./x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -n 4 -- -i 
+    testpmd>set fwd mac
+    testpmd>start tx_first
+
+5. Send traffic from Traffic generator to virtio device. 
+Set DEST MAC as virtio1's MAC(52:54:00:00:00:01), 
+set VLAN ID(Get from vhost-sample output, default is 1000) as virtio1's VLAN.
+Measure the Performance.
+
+
+Test Case 2: DPDK PVP performance on Normal path
+================================================
+
+Flow: 
+TG(Traffic generator) --> NIC --> Vhost --> Virtio--> Vhost--> NIC--> TG 
+
+On host:
+
+1. First build the vhost-switch sample. 
+
+2. Start up vhost-switch, mergeable 0 means the jubmo frame feature is
+disabled. vm2vm 0 means only one vm without vm2vm communication. Use 3core to
+launch the sample will get the best performance, 2 core will be used for data 
+path, one core is master core for some configuration.::
+
+    taskset -c 18-20 ./vhost-switch -c 0x1c0000 -n 4\
+    --huge-dir /mnt/huge --socket-mem 1024,1024 \
+    -- -p 0x1 --mergeable 0 --vm2vm 0 --socket-file ./vhost-net
+   
+
+3. Start VM with vhost-user as backend, add 1 virtio devices::
+ 
+    taskset -c 22-26 \
+    qemu-system-x86_64 -name vm1 -cpu host -enable-kvm -m 2048 \
+    -object memory-backend-file,id=mem,size=2048M,mem-path=/mnt/huge,share=on \
+     -numa node,memdev=mem -mem-prealloc \
+     -smp cores=5,sockets=1 -drive file=/home/osimg/f23_liu.img  \
+     -chardev socket,id=char0,path=./vhost-net \
+     -netdev type=vhost-user,id=mynet1,chardev=char0,vhostforce,queues=1 \
+     -device virtio-net-pci,mac=52:54:00:00:00:01,netdev=mynet1,mrg_rxbuf=off,mq=on \
+     -netdev tap,id=ipvm1,ifname=tap4,script=/etc/qemu-ifup \
+     -device rtl8139,netdev=ipvm1,id=net0,mac=00:00:00:00:10:01 -vnc :10 -daemonize
+   
+
+4. On VM1, ensure the same dpdk folder is copied and run testpmd, virtio 
+device is binded to igb_uio, use txqflags=0xf00 :
+    ./x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -n 4 -- -i --txqflags=0xf00
+    testpmd>set fwd mac
+    testpmd>start tx_first
+
+5. Send traffic from Traffic generator to virtio device.
+Set DEST MAC as virtio1's MAC(52:54:00:00:00:01),
+set VLAN ID(Get from vhost-sample output, default is 1000) as virtio1's VLAN.
+Measure the Performance.
+
+Test Case 3: DPDK PVP performance on Vector path
+================================================
+
+Flow: 
+TG(Traffic generator) --> NIC --> Vhost --> Virtio--> Vhost--> NIC--> TG 
+
+On host:
+
+1. First build the vhost-switch sample. 
+
+2. Start up vhost-switch, mergeable 0 means the jubmo frame feature is 
+disabled. vm2vm 0 means only one vm without vm2vm communication. Use 3core to
+launch the sample will get the best performance, 2 core will be used for data 
+path, one core is master core for some configuration.::
+
+    taskset -c 18-20 ./vhost-switch -c 0x1c0000 -n 4 \
+    --huge-dir /mnt/huge --socket-mem 1024,1024 \
+    -- -p 0x1 --mergeable 0 --vm2vm 0 --socket-file ./vhost-net
+   
+
+3. Start VM with vhost-user as backend, add 1 virtio devices::
+ 
+    taskset -c 22-26 \
+    qemu-system-x86_64 -name vm1 -cpu host -enable-kvm -m 2048 \
+     -object memory-backend-file,id=mem,size=2048M,mem-path=/mnt/huge,share=on \
+     -numa node,memdev=mem -mem-prealloc \
+     -smp cores=5,sockets=1 -drive file=/home/osimg/f23_liu.img  \
+     -chardev socket,id=char0,path=./vhost-net \
+     -netdev type=vhost-user,id=mynet1,chardev=char0,vhostforce,queues=1 \
+     -device virtio-net-pci,mac=52:54:00:00:00:01,netdev=mynet1,mrg_rxbuf=off,mq=on \
+     -netdev tap,id=ipvm1,ifname=tap4,script=/etc/qemu-ifup \
+     -device rtl8139,netdev=ipvm1,id=net0,mac=00:00:00:00:10:01 -vnc :10 -daemonize
+   
+
+4. On VM1, ensure the same dpdk folder is copied and run testpmd, virtio 
+device is binded to igb_uio, use txqflags=0xf01 :
+    ./x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -n 4 -- -i --txqflags=0xf01
+    testpmd>set fwd mac
+    testpmd>start tx_first
+
+5. Send traffic from Traffic generator to virtio device.
+Set DEST MAC as virtio1's MAC(52:54:00:00:00:01),
+set VLAN ID(Get from vhost-sample output, default is 1000) as virtio1's VLAN.
+Measure the Performance.
+
-- 
2.7.4