[spp] [PATCH 25/28] docs: clean up spp documents
ogawa.yasufumi at lab.ntt.co.jp
ogawa.yasufumi at lab.ntt.co.jp
Mon Feb 5 03:46:38 CET 2018
From: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>
* Create docs/samples/ to include other than configs of spp
command.
* Move spp command samples to /samples/command/spp/.
* Update spp command samples to be readable.
* Move 'qemu-ifup' sample to samples/.
* Remove markdown files of spp.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>
---
docs/sample_configs/1nfv_1vm_bi.config | 19 -
docs/sample_configs/1nfv_1vm_uni.config | 12 -
docs/sample_configs/1nfv_bi.config | 5 -
docs/sample_configs/2nfv_1ring_uni.config | 9 -
docs/sample_configs/2nfv_1vm_bi.config | 21 -
docs/sample_configs/2nfv_bi.config | 7 -
docs/samples/command/spp/1nfv_1vm_bi.config | 28 ++
docs/samples/command/spp/1nfv_1vm_uni.config | 21 +
docs/samples/command/spp/1nfv_bi.config | 10 +
docs/samples/command/spp/2nfv_1ring_uni.config | 18 +
docs/samples/command/spp/2nfv_1vm_bi.config | 30 ++
docs/samples/command/spp/2nfv_bi.config | 12 +
docs/{ => samples}/qemu-ifup | 0
docs/setup_guide.md | 523 -------------------------
docs/spp_commands.md | 90 -----
docs/workflow.md | 18 -
16 files changed, 119 insertions(+), 704 deletions(-)
delete mode 100644 docs/sample_configs/1nfv_1vm_bi.config
delete mode 100644 docs/sample_configs/1nfv_1vm_uni.config
delete mode 100644 docs/sample_configs/1nfv_bi.config
delete mode 100644 docs/sample_configs/2nfv_1ring_uni.config
delete mode 100644 docs/sample_configs/2nfv_1vm_bi.config
delete mode 100644 docs/sample_configs/2nfv_bi.config
create mode 100644 docs/samples/command/spp/1nfv_1vm_bi.config
create mode 100644 docs/samples/command/spp/1nfv_1vm_uni.config
create mode 100644 docs/samples/command/spp/1nfv_bi.config
create mode 100644 docs/samples/command/spp/2nfv_1ring_uni.config
create mode 100644 docs/samples/command/spp/2nfv_1vm_bi.config
create mode 100644 docs/samples/command/spp/2nfv_bi.config
rename docs/{ => samples}/qemu-ifup (100%)
delete mode 100644 docs/setup_guide.md
delete mode 100644 docs/spp_commands.md
delete mode 100644 docs/workflow.md
diff --git a/docs/sample_configs/1nfv_1vm_bi.config b/docs/sample_configs/1nfv_1vm_bi.config
deleted file mode 100644
index c4e8baa..0000000
--- a/docs/sample_configs/1nfv_1vm_bi.config
+++ /dev/null
@@ -1,19 +0,0 @@
-status
-sec 0;status
-sec 1;status
-sec 0;add ring 0
-sec 0;add ring 1
-sec 0;add ring 2
-sec 0;add ring 3
-sec 1;add ring 0
-sec 1;add ring 1
-sec 1;add ring 2
-sec 1;add ring 3
-sec 0;patch 0 2
-sec 0;patch 3 0
-sec 0;patch 1 4
-sec 0;patch 5 1
-sec 1;patch 0 3
-sec 1;patch 2 1
-sec 0;forward
-sec 1;forward
diff --git a/docs/sample_configs/1nfv_1vm_uni.config b/docs/sample_configs/1nfv_1vm_uni.config
deleted file mode 100644
index 202f216..0000000
--- a/docs/sample_configs/1nfv_1vm_uni.config
+++ /dev/null
@@ -1,12 +0,0 @@
-status
-sec 0;status
-sec 1;status
-sec 0;add ring 0
-sec 0;add ring 1
-sec 1;add ring 0
-sec 1;add ring 1
-sec 0;patch 0 2
-sec 0;patch 3 1
-sec 1;patch 0 1
-sec 0;forward
-sec 1;forward
diff --git a/docs/sample_configs/1nfv_bi.config b/docs/sample_configs/1nfv_bi.config
deleted file mode 100644
index 3e333db..0000000
--- a/docs/sample_configs/1nfv_bi.config
+++ /dev/null
@@ -1,5 +0,0 @@
-status
-sec 0;status
-sec 0;patch 0 1
-sec 0;patch 1 0
-sec 0;forward
diff --git a/docs/sample_configs/2nfv_1ring_uni.config b/docs/sample_configs/2nfv_1ring_uni.config
deleted file mode 100644
index be8f51c..0000000
--- a/docs/sample_configs/2nfv_1ring_uni.config
+++ /dev/null
@@ -1,9 +0,0 @@
-status
-sec 0;status
-sec 1;status
-sec 0;add ring 0
-sec 1;add ring 0
-sec 0;patch 0 2
-sec 1;patch 2 1
-sec 0;forward
-sec 1;forward
diff --git a/docs/sample_configs/2nfv_1vm_bi.config b/docs/sample_configs/2nfv_1vm_bi.config
deleted file mode 100644
index 2ba3175..0000000
--- a/docs/sample_configs/2nfv_1vm_bi.config
+++ /dev/null
@@ -1,21 +0,0 @@
-status
-sec 0;status
-sec 1;status
-sec 2;status
-sec 0;add ring 0
-sec 0;add ring 1
-sec 1;add ring 2
-sec 1;add ring 3
-sec 2;add ring 0
-sec 2;add ring 1
-sec 2;add ring 2
-sec 2;add ring 3
-sec 0;patch 0 2
-sec 0;patch 3 0
-sec 1;patch 3 1
-sec 1;patch 1 2
-sec 2;patch 0 3
-sec 2;patch 2 1
-sec 0;forward
-sec 1;forward
-sec 2;forward
diff --git a/docs/sample_configs/2nfv_bi.config b/docs/sample_configs/2nfv_bi.config
deleted file mode 100644
index cad6bc7..0000000
--- a/docs/sample_configs/2nfv_bi.config
+++ /dev/null
@@ -1,7 +0,0 @@
-status
-sec 0;status
-sec 1;status
-sec 0;patch 0 1
-sec 1;patch 1 0
-sec 0;forward
-sec 1;forward
diff --git a/docs/samples/command/spp/1nfv_1vm_bi.config b/docs/samples/command/spp/1nfv_1vm_bi.config
new file mode 100644
index 0000000..ae6104b
--- /dev/null
+++ b/docs/samples/command/spp/1nfv_1vm_bi.config
@@ -0,0 +1,28 @@
+# Show status
+status
+
+# Show status of secondaries
+sec 1;status
+sec 2;status
+
+# Add rings to secondaries
+sec 1;add ring 0
+sec 1;add ring 1
+sec 1;add ring 2
+sec 1;add ring 3
+sec 2;add ring 0
+sec 2;add ring 1
+sec 2;add ring 2
+sec 2;add ring 3
+
+# Patch all of ports as bi-directional
+sec 1;patch 0 2
+sec 1;patch 3 0
+sec 1;patch 1 4
+sec 1;patch 5 1
+sec 2;patch 0 3
+sec 2;patch 2 1
+
+# Start forwarding
+sec 1;forward
+sec 2;forward
diff --git a/docs/samples/command/spp/1nfv_1vm_uni.config b/docs/samples/command/spp/1nfv_1vm_uni.config
new file mode 100644
index 0000000..74aff3d
--- /dev/null
+++ b/docs/samples/command/spp/1nfv_1vm_uni.config
@@ -0,0 +1,21 @@
+# Show status
+status
+
+# Show status of secondaries
+sec 1;status
+sec 2;status
+
+# Add rings to secondaries
+sec 1;add ring 0
+sec 1;add ring 1
+sec 2;add ring 0
+sec 2;add ring 1
+
+# Patch all of ports as uni-directional
+sec 1;patch 0 2
+sec 1;patch 3 1
+sec 2;patch 0 1
+
+# Start forwarding
+sec 1;forward
+sec 2;forward
diff --git a/docs/samples/command/spp/1nfv_bi.config b/docs/samples/command/spp/1nfv_bi.config
new file mode 100644
index 0000000..0142988
--- /dev/null
+++ b/docs/samples/command/spp/1nfv_bi.config
@@ -0,0 +1,10 @@
+# Show status
+status
+sec 1;status
+
+# Patch ports as bi-directional
+sec 1;patch 0 1
+sec 1;patch 1 0
+
+# Start forwarding
+sec 1;forward
diff --git a/docs/samples/command/spp/2nfv_1ring_uni.config b/docs/samples/command/spp/2nfv_1ring_uni.config
new file mode 100644
index 0000000..c3e391c
--- /dev/null
+++ b/docs/samples/command/spp/2nfv_1ring_uni.config
@@ -0,0 +1,18 @@
+# Show status
+status
+
+# Show status of secondaries
+sec 1;status
+sec 2;status
+
+# Add a ring to secondaries
+sec 1;add ring 0
+sec 2;add ring 0
+
+# Patch all of ports as uni-directional
+sec 1;patch 0 2
+sec 2;patch 2 1
+
+# Start forwarding
+sec 1;forward
+sec 2;forward
diff --git a/docs/samples/command/spp/2nfv_1vm_bi.config b/docs/samples/command/spp/2nfv_1vm_bi.config
new file mode 100644
index 0000000..3537c91
--- /dev/null
+++ b/docs/samples/command/spp/2nfv_1vm_bi.config
@@ -0,0 +1,30 @@
+# Show status
+status
+
+# Show status of secondaries
+sec 1;status
+sec 2;status
+sec 3;status
+
+# Add rings to secondaries
+sec 1;add ring 0
+sec 1;add ring 1
+sec 2;add ring 2
+sec 2;add ring 3
+sec 3;add ring 0
+sec 3;add ring 1
+sec 3;add ring 2
+sec 3;add ring 3
+
+# Patch all of ports as bi-directional
+sec 1;patch 0 2
+sec 1;patch 3 0
+sec 2;patch 3 1
+sec 2;patch 1 2
+sec 3;patch 0 3
+sec 3;patch 2 1
+
+# Start forwarding
+sec 2;forward
+sec 2;forward
+sec 3;forward
diff --git a/docs/samples/command/spp/2nfv_bi.config b/docs/samples/command/spp/2nfv_bi.config
new file mode 100644
index 0000000..4c4768c
--- /dev/null
+++ b/docs/samples/command/spp/2nfv_bi.config
@@ -0,0 +1,12 @@
+# Show status
+status
+
+# Patch port 0 and 1 as bi-directioonal
+sec 1;status
+sec 2;status
+sec 1;patch 0 1
+sec 2;patch 1 0
+
+# Start forwarding
+sec 1;forward
+sec 2;forward
diff --git a/docs/qemu-ifup b/docs/samples/qemu-ifup
similarity index 100%
rename from docs/qemu-ifup
rename to docs/samples/qemu-ifup
diff --git a/docs/setup_guide.md b/docs/setup_guide.md
deleted file mode 100644
index f806127..0000000
--- a/docs/setup_guide.md
+++ /dev/null
@@ -1,523 +0,0 @@
-## Table of Contents
-
-- [Sample usage of the application](#sample-usage-of-the-application)
- - [Compilation](#compilation)
- - [Start Controller](#start-controller)
- - [Start spp_primary](#start-spp_primary)
- - [Start spp_nfv](#start-spp_nfv)
- - [Start spp_vm](#start-spp_vm)
-
-- [Test Setups](#test-setups)
- - [Test Setup 1: Single NFV](#test-setup-1-single-nfv)
- - [Test Setup 2: Dual NFV](#test-setup-2-dual-nfv)
- - [Test Setup 3: Dual NFV with ring pmd](#test-setup-3-dual-nfv-with-ring-pmd)
- - [Test Setup 4: Single NFV with VM through vhost pmd](#test-setup-4-single-nfv-with-vm-through-vhost-pmd)
-- [Optimizing qemu performance](#optimizing-qemu-performance)
-
-
-## Sample usage of the application
-
-### Compilation
-
-Compile DPDK
-* Change to DPDK directory
-* Set `RTE_SDK` variable to current folder
-* Set `RTE_TARGET` variable to any valid target.
-* Compile DPDK: "make T=x86_64-native-linuxapp-gcc install"
-
-Compile SPP
-* Change to SPP directory
-* Compile SPP: "make"
-
-### Start Controller
-
-First, start spp.py with port numbers for spp_primary and secondary processes.
-
-```sh
-$ python spp.py -p 5555 -s 6666
-primary port : 5555
-secondary port : 6666
-Welcome to the spp. Type help or ? to list commands.
-
-spp >
-```
-
-### Start spp_primary
-
-Start spp_primary with SPP options.
-* -p: port mask
-* -n: number of ring
-* -s: IP address of controller and port for primary
-
-```sh
-$ sudo ./src/primary/src/primary/x86_64-native-linuxapp-gcc/spp_primary \
- -c 0x02 -n 4 \
- --socket-mem 512,512 \
- --huge-dir=/dev/hugepages \
- --proc-type=primary \
- -- \
- -p 0x03 \
- -n 4 \
- -s 192.168.122.1:5555
-```
-
-### Start spp_nfv
-
-There are two types fo secondary, spp_nfv and spp_vm.
-
-Start two spp_nfv with SPP Options
-* -n: seconary id (n > 0)
-* -s: ipaddr of controller and port for secondary
-
-```sh
-$ sudo ./src/nfv/src/nfv/x86_64-native-linuxapp-gcc/spp_nfv \
- -c 0x06 -n 4 \
- --proc-type=secondary \
- -- \
- -n 1 \
- -s 192.168.122.1:6666
-
-$ sudo ./src/nfv/src/nfv/x86_64-native-linuxapp-gcc/spp_nfv \
- -c 0x0A -n 4 \
- --proc-type=secondary \
- -- \
- -n 2 \
- -s 192.168.122.1:6666
-```
-
-### Start spp_vm
-
-Start a VM for running spp_vm.
-You need to add vhost interface while starting VM.
-Vhost interface is supported to communicate between guest and host.
-
-To start spp_vm, "qemu-ifup" script required.
-Please copy "docs/qemu-ifup" to /etc/qemu-ifup of host.
-
-SPP controller should do a "sec x;add vhost y" before starting the VM.
-x is an id of spp_nfv and y is vhost port id (num of socket).
-Vhost port is created as "/tmp/sock'y'".
-
-To add vhost port 0 to sec 1,
-```
-spp > sec 1;add vhost 0
-```
-and confirm that "/tmp/sock0" is created.
-
-Common qemu command line without vhost is here.
-
-```sh
-$ sudo ./x86_64-softmmu/qemu-system-x86_64 \
- -cpu host \
- -enable-kvm \
- -object memory-backend-file,id=mem,size=2048M,mem-path=/dev/hugepages,share=on \
- -numa node,memdev=mem \
- -mem-prealloc \
- -hda /home/dpdk/debian_wheezy_amd64_standard.qcow2 \
- -m 2048 \
- -smp cores=4,threads=1,sockets=1 \
- -device e1000,netdev=net0,mac=DE:AD:BE:EF:00:01 \
- -netdev tap,id=net0 \
- -nographic -vnc :2
-```
-
-Add chardev and another netdev,device options for vhost interface.
-
-```sh
- sudo ./x86_64-softmmu/qemu-system-x86_64 \
- -cpu host \
- -enable-kvm \
- -object memory-backend-file,id=mem,size=2048M,mem-path=/dev/hugepages,share=on \
- -numa node,memdev=mem \
- -mem-prealloc \
- -hda /home/dpdk/debian_wheezy_amd64_standard.qcow2 \
- -m 2048 \
- -smp cores=4,threads=1,sockets=1 \
- -device e1000,netdev=net0,mac=DE:AD:BE:EF:00:01 \
- -netdev tap,id=net0 \
- -chardev socket,id=chr0,path=/tmp/sock0 \ # vhost port
- -netdev vhost-user,id=net1,chardev=chr0,vhostforce \ # netdev for vhost-user
- -device virtio-net-pci,netdev=net1 \ # device as virtio-net-pci
- -nographic -vnc :2
-```
-
-Compile DPDK and SPP inside the VM and start spp_vm.
-
-SPP options
-* -p: port mask
-* -n: secondary id
-* -s: IP address of controller and port for secondary
-
-```sh
-$ sudo ./src/vm/src/vm/x86_64-native-linuxapp-gcc/spp_vm \
- -c 0x03 -n 4 \
- --proc-type=primary \
- -- \
- -p 0x01 \
- -n 1 \
- -s 192.168.122.1:6666
-```
-
-
-## Test Setups
-
-### Test Setup 1: Single NFV
-
-```
- __
- +--------------+ |
- | spp_nfv | |
- | (sec 1) | |
- +--------------+ |
- ^ : |
- | | |
- : v |
- +----+----------+-------------------------------------------------+ |
- | | primary | ^ : | |
- | +----------+ : : | |
- | : : | |
- | +----------+ +---------+ | | host
- | : v | |
- | +--------------+ +--------------+ | |
- | | phy port 0 | | phy port 1 | | |
- +------------------+--------------+------------+--------------+---+ __|
- ^ :
- | |
- : v
-
-```
-
-Check status of spp_nfv in spp controller.
-
-```
-spp > sec 1;status
-recv:6:{Client ID 1 Idling
-1
-port id: 0,on,PHY,outport: -99
-port id: 1,on,PHY,outport: -99
-}
-```
-
-This message means that sec 1 has two physical ports refered as port 0, 1.
-"outpport: -99" means the destionation is no assigned.
-
-#### Configure spp_nfv as L2fwd
-
-Assing the destination of ports by "patch" subcommand and start forwarding.
-It is bi-directional.
-```
-spp > sec 1;patch 0 1
-spp > sec 1;patch 1 0
-spp > sec 1;forward
-```
-
-Check the status of sec 1 is updated.
-```
-spp > sec 1;status
-recv:6:{Client ID 1 Running
-1
-port id: 0,on,PHY,outport: 1
-port id: 1,on,PHY,outport: 0
-}
-```
-
-Clear patch configuration.
-```
-spp > sec 1;stop
-spp > sec 1;patch reset
-```
-
-#### Configure spp_nfv for loopback
-
-Another example of patch configuration.
-```
-spp > sec 1;patch 0 0
-spp > sec 1;patch 1 1
-spp > sec 1;forward
-```
-
-
-### Test Setup 2: Dual NFV
-
-```
- __
- +--------------+ +--------------+ |
- | spp_nfv | | spp_nfv | |
- | (sec 1) | | (sec 2) | |
- +--------------+ +--------------+ |
- ^ : : : |
- | | +--------+ | |
- : v | v |
- +----+----------+-----------------------+-------------------------+ |
- | | primary | ^ : | : | |
- | +----------+ | +------+--------+ : | |
- | : | : : | |
- | : +------+ : | | | host
- | : v v v | |
- | +--------------+ +--------------+ | |
- | | phy port 0 | | phy port 1 | | |
- +------------------+--------------+------------+--------------+---+ __|
- ^ :
- | |
- : v
-
-```
-
-#### Configuration for two L2fwds
-
-Assign patch configuration for sec 1 and 2.
-It is uni-directional.
-```
-spp > sec 1;patch 0 1
-spp > sec 2;patch 1 0
-spp > sec 1;forward
-spp > sec 2;forward
-```
-
-```
-
- __
- +--------------+ +--------------+ |
- | spp_nfv | | spp_nfv | |
- | (sec 1) | | (sec 2) | |
- +--------------+ +--------------+ |
- ^ : ^ : |
- | | | | |
- : v : v |
- +----+----------+-------------------------------------------------+ |
- | | primary | ^ : ^ : | |
- | +----------+ | : | : | |
- | : : : : | |
- | : | : | | | host
- | : v : v | |
- | +--------------+ +--------------+ | |
- | | phy port 0 | | phy port 1 | | |
- +------------------+--------------+------------+--------------+---+ __|
- ^ ^
- | |
- v v
-
-```
-
-#### Configuration for loopback
-
-```
-spp > sec 1;patch 0 0
-spp > sec 2;patch 1 1
-spp > sec 1;forward
-spp > sec 2;forward
-```
-
-
-### Test Setup 3: Dual NFV with ring pmd
-
-```
- __
- +----------+ ring 0 +----------+ |
- | spp_nfv | +--------+ | spp_nfv | |
- | (sec 1) | -> | | | |- > | (sec 2) | |
- +----------+ +--------+ +----------+ |
- ^ : |
- | | |
- : v |
- +----+----------+-------------------------------------------------+ |
- | | primary | ^ : | |
- | +----------+ | : | |
- | : : | |
- | : | | | host
- | : v | |
- | +--------------+ +--------------+ | |
- | | phy port 0 | | phy port 1| | |
- +------------------+--------------+------------+--------------+---+ __|
- ^ :
- | |
- : v
-
-```
-
-#### Configuration for Uni directional L2fwd
-
-Ring is an interface between spp_nfvs.
-The maximum number of rings is defined as an option of spp_primary.
-spp_nfv is able to find a ring by adding it.
-
-Please notice that sec 1 has a new port id 2 after adding ring 0.
-```
-spp > sec 1;add ring 0
-recv:6:{addring0}
-spp > sec 1;status
-recv:6:{Client ID 1 Idling
-1
-port id: 0,on,PHY,outport: -99
-port id: 1,on,PHY,outport: -99
-port id: 2,on,RING(0),outport: -99
-}
-```
-
-To configure sec 1 and 2 forwarding thorugh ring 0,
-add the ring both of them and patch.
-```
-spp > sec 1;add ring 0
-spp > sec 2;add ring 0
-spp > sec 1;patch 0 2
-spp > sec 2;patch 2 1
-spp > sec 1;forward
-spp > sec 2;forward
-```
-
-#### Configuration for Bi directional L2fwd
-
-```
- __
- ring 0 |
- +--------+ |
- +------------+ <--| | | |<-- +-----------+ |
- | p3| +--------+ |p3 | |
- | spp_nfv | | spp_nfv | |
- | (sec 1) p2|--> +--------+ -->|p2 (sec 2) | |
- +------------+ | | | | +-----------+ |
- ^ +--------+ ^ |
- | ring 1 | |
- v v |
- +---+----------+--------------------------------------------------+ |
- | | primary | ^ ^ | |
- | +----------+ | : | |
- | : : | |
- | : | | | host
- | v v | |
- | +--------------+ +--------------+ | |
- | | phy port 0 | | phy port 1 | | |
- +------------------+--------------+------------+--------------+---+ __|
- ^ ^
- | |
- v v
-
-```
-
-Add ring 0 and 1 for sec 1.
-
-```
-spp > sec 1;add ring 0
-spp > sec 1;add ring 1
-spp > sec 1;status
-recv:6:{Client ID 1 Idling
-1
-port id: 0,on,PHY,outport: -99
-port id: 1,on,PHY,outport: -99
-port id: 2,on,RING(0),outport: -99
-port id: 3,on,RING(1),outport: -99
-}
-```
-
-Then, add also for sec 2 and patch.
-"p2" and "p3" inside of spp_nfv in the figure are port ids.
-```
-spp > sec 2;add ring 0
-spp > sec 2;add ring 1
-spp > sec 1;patch 0 2
-spp > sec 1;patch 3 0
-spp > sec 2;patch 1 3
-spp > sec 2;patch 2 1
-spp > sec 1;forward
-spp > sec 2;forward
-```
-
-### Test Setup 4: Single NFV with VM through vhost pmd
-
-```
- __
- +-----------------------+ |
- | guest | |
- | | |
- | +--------------+ | | guest
- | | spp_vm | | | 192.168.122.51
- | | (sec 2) | | |
- | | p0 | | |
- +---+--------------+----+ __|
- ^ :
- | virtio |
- | V __
- +--------------------+ |
- | spp_nfv | |
- | p2 (sec 1) | |
- +--------------------+ |
- ^ : |
- | +---------- + |
- : v |
- +----+----------+--------------------------------------------+ |
- | | primary | ^ : | |
- | +----------+ | : | |
- | : | | | host
- | : v | | 192.168.122.1
- | +--------------+ +--------------+ | |
- | | phy port 0 | | phy port 1 | | |
- +------------------+--------------+-------+--------------+---+ __|
- ^ :
- | |
- : v
-
-```
-
-#### Configuration for Uni directional L2fwd
-
-Remove vhost port "/tmp/sock0" before starting VM if exists.
-
-```sh
-$ rm /tmp/sock0
-```
-
-Then, add sock0 from spp controller.
-```
-spp > sec 1;add vhost 0
-```
-
-Start VM and run spp_vm with sec id 2 inside VM.
-You can find sec 2 from spp controller after spp_vm is launched.
-
-Configure patch.
-```
-spp > sec 1;patch 0 2
-spp > sec 1;patch 2 1
-spp > sec 2;patch 0 0
-spp > sec 1;forward
-spp > sec 2;forward
-```
-
-
-### Optimizing qemu performance
-
-First, find out the PID for qemu-system-x86 process.
-
-```sh
-$ ps ea
- PID TTY STAT TIME COMMAND
-192606 pts/11 Sl+ 4:42 ./x86_64-softmmu/qemu-system-x86_64 -cpu host -enable-kvm -object memory-backend-file,id=mem,siz
-```
-
-Using `pstree` to list out qemu-system-x86_64 threads.
-
-```sh
-$ pstree -p 192606
-qemu-system-x86(192606)--+--{qemu-system-x8}(192607)
- |--{qemu-system-x8}(192623)
- |--{qemu-system-x8}(192624)
- |--{qemu-system-x8}(192625)
- |--{qemu-system-x8}(192626)
-```
-
-To Optimize, use `taskset` to pin each thread
-
-```sh
-$ sudo taskset -pc 4 192623
-pid 192623's current affinity list: 0-31
-pid 192623's new affinity list: 4
-$ sudo taskset -pc 5 192624
-pid 192624's current affinity list: 0-31
-pid 192624's new affinity list: 5
-$ sudo taskset -pc 6 192625
-pid 192625's current affinity list: 0-31
-pid 192625's new affinity list: 6
-$ sudo taskset -pc 7 192626
-pid 192626's current affinity list: 0-31
-pid 192626's new affinity list: 7
-```
diff --git a/docs/spp_commands.md b/docs/spp_commands.md
deleted file mode 100644
index 1cd86fc..0000000
--- a/docs/spp_commands.md
+++ /dev/null
@@ -1,90 +0,0 @@
-spp commands:
-
-* help [> help]
-
- Displays brief help
-
-
-* status [> status]
-
- Display number of connected primary and secondary application count
- Also display connected secondary application client_id
-
-
-* sec <id>
-
- Send commands to secondary applications with client id <id>:
-
- * status [> sec 0;status]
-
- * add
-
- * ring <id> [> sec 0;add ring 0]
-
- * vhost <id> [> sec 0;add vhost 0]
-
- * patch <id> <id> [> sec 0;patch 0 2]
-
- * reset [> sec 0; patch reset]
-
- * forward [> sec 0;forward]
-
- * del
-
- * ring <id> [> sec 0; del ring 0]
-
- * exit [> sec 0;exit]
-
- * stop [>sec 0;stop]
-
-
-* record, playback [> record a.txt] [> playback a.txt]
-
- To record commands in SPP:-
- spp > record <filename>
-
- To stop recording
- spp > bye
-
- To playback commands
- spp > playback <filename>
-
- '#' character at the beginning of the line used for comments
-
-
-* bye [> bye]
-
- Close the spp
-
- * sec [> bye sec]
-
- Close all secondary app and spp
-
- * all [> bye all]
-
- Close all secondary app, primary app and spp
-
-
-* pri
-
- Send commands to primary applications:
-
- * status [> pri status]
-
- * add
-
- * ring <id> [> pri add ring 0]
-
- * del
-
- * ring <id> [> pri del ring 0]
-
- * exit [> pri exit]
-
- * stop [> pri stop]
-
- * start [> pri start]
-
- * clear [> pri clear]
-
- Clear statistics
diff --git a/docs/workflow.md b/docs/workflow.md
deleted file mode 100644
index 53a5dd8..0000000
--- a/docs/workflow.md
+++ /dev/null
@@ -1,18 +0,0 @@
-## SPP Workflow
-
-SPP is a standalone application uses DPDK as library.
-
-There is main development branch:
-- master branch: spp development branch.
-
-For each DPDK release, SPP master branch is tagged with same release version.
-Master branch head always has latest development SPP source codes.
-
-
-### To submit a patch:
-
-Please send the patch to one of the developers:
-- Ferruh Yigit <ferruh.yigit at intel.com>
-- Gerald Rogers <gerald.rogers at intel.com>
-- Sy Jong Choi <sy.jong.choi at intel.com>
-- dpdk-spp at intel.com
--
2.13.1
More information about the spp
mailing list