doc_fixup: Grammar and link fixes to documentation

[vswitchperf.git] / docs / userguide / testusage.rst

diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
index 104723e..c020b6c 100755 (executable)
--- a/docs/userguide/testusage.rst
+++ b/docs/userguide/testusage.rst
@@ -16,6 +16,10 @@ support in VSPERF includes:
 - Spirent traffic generator (TestCenter hardware chassis or TestCenter virtual
   in a VM) and a VM to run the Spirent Virtual Deployment Service image,
   formerly known as "Spirent LabServer".
+- Xena Network traffic generator (Xena hardware chassis) that houses the Xena
+  Traffic generator modules.
+- Moongen software traffic generator. Requires a separate machine running
+  moongen to execute packet generation.
 
 If you want to use another traffic generator, please select the Dummy generator
 option as shown in `Traffic generator instructions
@@ -114,6 +118,12 @@ deployment scenarios. The image can be downloaded from
 
     $ wget http://artifacts.opnfv.org/vswitchperf/vloop-vnf-ubuntu-14.04_20151216.qcow2
 
+Newer vloop_vnf images are available. Please reference the
+installation instructions for information on these images
+`installation instructions
+<http://artifacts.opnfv.org/vswitchperf/docs/configguide/installation.html>`__
+
+
 vloop_vnf forwards traffic through a VM using one of:
 * DPDK testpmd
 * Linux Bridge
@@ -396,7 +406,7 @@ Execution of test with PCI passthrough with vswitch disabled:
 .. code-block:: console
 
     $ ./vsperf --conf-file=<path_to_custom_conf>/10_custom.conf
-               --vswtich none --vnf QemuPciPassthrough pvp_tput
+               --vswitch none --vnf QemuPciPassthrough pvp_tput
 
 Any of supported guest-loopback-application_ can be used inside VM with
 PCI passthrough support.
@@ -437,6 +447,64 @@ Guest loopback application must be configured, otherwise traffic
 will not be forwarded by VM and testcases with PVP and PVVP deployments
 will fail. Guest loopback application is set to 'testpmd' by default.
 
+Multi-Queue Configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+VSPerf currently supports multi-queue with the following limitations:
+
+ 1.  Execution of pvp/pvvp tests require testpmd as the loopback if multi-queue
+     is enabled at the guest.
+
+ 2.  Requires QemuDpdkVhostUser as the vnf.
+
+ 3.  Requires switch to be set to OvsDpdkVhost.
+
+ 4.  Requires QEMU 2.5 or greater and any OVS version higher than 2.5. The
+     default upstream package versions installed by VSPerf satisfy this
+     requirement.
+
+To enable multi-queue modify the ''02_vswitch.conf'' file to enable multi-queue
+on the switch.
+
+  .. code-block:: console
+
+     VSWITCH_MULTI_QUEUES = 2
+
+**NOTE:** you should consider using the switch affinity to set a pmd cpu mask
+that can optimize your performance. Consider the numa of the NIC in use if this
+applies by checking /sys/class/net/<eth_name>/device/numa_node and setting an
+appropriate mask to create PMD threads on the same numa node.
+
+When multi-queue is enabled, each dpdk or dpdkvhostuser port that is created
+on the switch will set the option for multiple queues.
+
+To enable multi-queue on the guest modify the ''04_vnf.conf'' file.
+
+  .. code-block:: console
+
+     GUEST_NIC_QUEUES = 2
+
+Enabling multi-queue at the guest will add multiple queues to each NIC port when
+qemu launches the guest.
+
+Testpmd should be configured to take advantage of multi-queue on the guest. This
+can be done by modifying the ''04_vnf.conf'' file.
+
+  .. code-block:: console
+
+     GUEST_TESTPMD_CPU_MASK = '-l 0,1,2,3,4'
+
+     GUEST_TESTPMD_NB_CORES = 4
+     GUEST_TESTPMD_TXQ = 2
+     GUEST_TESTPMD_RXQ = 2
+
+**NOTE:** The guest SMP cores must be configured to allow for testpmd to use the
+optimal number of cores to take advantage of the multiple guest queues.
+
+**NOTE:** For optimal performance guest SMPs should be on the same numa as the
+NIC in use if possible/applicable. Testpmd should be assigned at least
+(nb_cores +1) total cores with the cpu mask.
+
 Executing Packet Forwarding tests
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -468,7 +536,10 @@ for selected Packet Forwarder:
 
    # testpmd configuration
    TESTPMD_ARGS = []
-   # packet forwarding mode: io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho
+   # packet forwarding mode supported by testpmd; Please see DPDK documentation
+   # for comprehensive list of modes supported by your version.
+   # e.g. io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho|...
+   # Note: Option "mac_retry" has been changed to "mac retry" since DPDK v16.07
    TESTPMD_FWD_MODE = 'csum'
    # checksum calculation layer: ip|udp|tcp|sctp|outer-ip
    TESTPMD_CSUM_LAYER = 'ip'
@@ -584,5 +655,5 @@ More information
 ^^^^^^^^^^^^^^^^
 
 For more information and details refer to the vSwitchPerf user guide at:
-http://artifacts.opnfv.org/vswitchperf/brahmaputra/userguide/index.html
+http://artifacts.opnfv.org/vswitchperf/docs/userguide/index.html