summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFerruh Yigit <ferruh.yigit@intel.com>2017-02-23 15:55:11 +0000
committerFerruh Yigit <ferruh.yigit@intel.com>2017-05-16 12:09:56 +0100
commit400c3fc3aa422b1ab46456ae476eba575feb7c64 (patch)
tree0e3ab31ac0331154d824c651670200b5d8cf2e7a
parent23aef3b09e70d3d90057ab28d1222404db89ecdc (diff)
downloadspp-400c3fc3aa422b1ab46456ae476eba575feb7c64.zip
spp-400c3fc3aa422b1ab46456ae476eba575feb7c64.tar.gz
spp-400c3fc3aa422b1ab46456ae476eba575feb7c64.tar.xz
doc: break long command lines
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
-rw-r--r--docs/setup_guide.md80
1 files changed, 70 insertions, 10 deletions
diff --git a/docs/setup_guide.md b/docs/setup_guide.md
index 0c56b73..319035f 100644
--- a/docs/setup_guide.md
+++ b/docs/setup_guide.md
@@ -17,19 +17,49 @@ python spp.py -p 5555 -s 6666
Start spp_primary
-----------------
-sudo ./src/primary/src/primary/x86_64-ivshmem-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
+sudo ./src/primary/src/primary/x86_64-ivshmem-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
-------------
-sudo ./src/nfv/src/nfv/x86_64-ivshmem-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-ivshmem-linuxapp-gcc/spp_nfv 0x0A -n 4 --proc-type=secondary -- -n 1 -s 192.168.122.1:6666
+sudo ./src/nfv/src/nfv/x86_64-ivshmem-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-ivshmem-linuxapp-gcc/spp_nfv \
+ -c 0x0A -n 4 \
+ --proc-type=secondary \
+ -- \
+ -n 1 \
+ -s 192.168.122.1:6666
Start VM (QEMU)
---------------
[NOTE: Custom QEMU version required]
Common qemu command line:
-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
+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
To start spp_vm "qemu-ifup" script required, please copy docs/qemu-ifup to host /etc/qemu-ifup
@@ -44,20 +74,50 @@ ring based (ivshmem)
APP: QEMU command line for config 'pp_ivshmem':
-device ivshmem,size=2048M,shm=fd:/dev/hugepages/rtemap_0:0x0:0x40000000:/dev/zero:0x0:0x3fffc000:/var/run/.dpdk_ivshmem_metadata_pp_ivshmem:0x0:0x4000
- Insert into qemu command line:-
- 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 -device ivshmem,size=2048M,shm=fd:/dev/hugepages/rtemap_0:0x0:0x40000000:/dev/zero:0x0:0x3fffc000:/var/run/.dpdk_ivshmem_metadata_pp_ivshmem:0x0:0x4000 -nographic
+ Insert into qemu command line:
+ 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 \
+ -device ivshmem,size=2048M,shm=fd:/dev/hugepages/rtemap_0:0x0:0x40000000:/dev/zero:0x0:0x3fffc000:/var/run/.dpdk_ivshmem_metadata_pp_ivshmem:0x0:0x4000 \
+ -nographic -vnc :2
vhost interface
~~~~~~~~~~~~~~~~~
- spp should do a "sec x:add vhost y" before starting the VM. x: vnf number, y: vhost port id.
- Needs vhost argument for qemu:
- 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 -netdev vhost-user,id=net1,chardev=chr0,vhostforce -device virtio-net-pci,netdev=net1 -nographic -vnc :2
-
+ 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 \
+ -netdev vhost-user,id=net1,chardev=chr0,vhostforce \
+ -device virtio-net-pci,netdev=net1 \
+ -nographic -vnc :2
Start spp_vm (Inside the VM)
----------------------------
-sudo ./src/vm/src/vm/x86_64-ivshmem-linuxapp-gcc/spp_vm -c 0x03 -n 4 --proc-type=primary -- -p 0x01 -n 1 -s 192.168.122.1:6666
-
+sudo ./src/vm/src/vm/x86_64-ivshmem-linuxapp-gcc/spp_vm \
+ -c 0x03 -n 4 \
+ --proc-type=primary \
+ -- \
+ -p 0x01 \
+ -n 1 \
+ -s 192.168.122.1:6666
Test Setups
===========