diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/configguide/installation.rst | 12 | ||||
| -rw-r--r-- | docs/configguide/trafficgen.rst | 4 | ||||
| -rw-r--r-- | docs/design/trafficgen_integration_guide.rst | 10 | ||||
| -rwxr-xr-x | docs/design/vswitchperf_design.rst | 10 | ||||
| -rwxr-xr-x | docs/userguide/testusage.rst | 7 | ||||
| -rwxr-xr-x | docs/userguide/yardstick.rst | 2 |
6 files changed, 29 insertions, 16 deletions
diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst index 048c2675..70572b07 100755 --- a/docs/configguide/installation.rst +++ b/docs/configguide/installation.rst @@ -186,9 +186,19 @@ parameter. In recent vswitchd versions, option VSWITCHD_DPDK_CONFIG will be used to configure vswitchd via ovs-vsctl calls. With the --socket-mem argument set to use 1 hugepage on the specified sockets as -seen above, the configuration will need 9 hugepages total to run all tests +seen above, the configuration will need 10 hugepages total to run all tests within vsperf if the pagesize is set correctly to 1GB. +VSPerf will verify hugepage amounts are free before executing test +environments. In case of hugepage amounts not being free, test initialization +will fail and testing will stop. + +**Please Note**: In some instances on a test failure dpdk resources may not +release hugepages used in dpdk configuration. It is recommended to configure a +few extra hugepages to prevent a false detection by VSPerf that not enough free +hugepages are available to execute the test environment. Normally dpdk would use +previously allocated hugepages upon initialization. + Depending on your OS selection configuration of hugepages may vary. Please refer to your OS documentation to set hugepages correctly. It is recommended to set the required amount of hugepages to be allocated by default on reboots. diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst index 302a8d5e..939b6cad 100644 --- a/docs/configguide/trafficgen.rst +++ b/docs/configguide/trafficgen.rst @@ -72,12 +72,12 @@ OR from the commandline: $ ./vsperf --test-params "pkt_sizes=x,y" $TESTNAME You can also modify the traffic transmission duration and the number -of trials run by the traffic generator by extending the example +of tests run by the traffic generator by extending the example commandline above to: .. code-block:: console - $ ./vsperf --test-params "pkt_sizes=x,y;duration=10;rfc2455_trials=3" $TESTNAME + $ ./vsperf --test-params "pkt_sizes=x,y;duration=10;rfc2544_tests=1" $TESTNAME Dummy Setup ------------ diff --git a/docs/design/trafficgen_integration_guide.rst b/docs/design/trafficgen_integration_guide.rst index a30b2d61..266c6bc0 100644 --- a/docs/design/trafficgen_integration_guide.rst +++ b/docs/design/trafficgen_integration_guide.rst @@ -161,9 +161,9 @@ Example of synchronous interfaces: .. code-block:: python - def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20, + def send_rfc2544_throughput(self, traffic=None, tests=1, duration=20, lossrate=0.0): - def send_rfc2544_back2back(self, traffic=None, trials=1, duration=20, + def send_rfc2544_back2back(self, traffic=None, tests=1, duration=20, lossrate=0.0): def send_cont_traffic(self, traffic=None, duration=20): @@ -171,11 +171,11 @@ Example of asynchronous interfaces: .. code-block:: python - def start_rfc2544_throughput(self, traffic=None, trials=3, duration=20, + def start_rfc2544_throughput(self, traffic=None, tests=1, duration=20, lossrate=0.0): def wait_rfc2544_throughput(self): - def start_rfc2544_back2back(self, traffic=None, trials=1, duration=20, + def start_rfc2544_back2back(self, traffic=None, tests=1, duration=20, lossrate=0.0): def wait_rfc2544_back2back(self): @@ -221,7 +221,7 @@ functions: * param **vlan**: A dictionary with vlan specific parameters, e.g. **priority**, **cfi**, **id** and vlan on/off switch **enabled**. - * param **trials**: Number of trials to execute. + * param **tests**: Number of times the test is executed. * param **duration**: Duration of continuous test or per iteration duration in case of RFC2544 throughput or back2back traffic types. * param **lossrate**: Acceptable lossrate percentage. diff --git a/docs/design/vswitchperf_design.rst b/docs/design/vswitchperf_design.rst index 53515249..e61b3ea6 100755 --- a/docs/design/vswitchperf_design.rst +++ b/docs/design/vswitchperf_design.rst @@ -53,7 +53,7 @@ for development purposes: .. code-block:: console - $ ./vsperf --test-params 'duration=10;rfc2544_trials=1;pkt_sizes=64' --tests 'pvp_tput' + $ ./vsperf --test-params 'duration=10;rfc2544_tests=1;pkt_sizes=64' --tests 'pvp_tput' Typical Test Sequence ===================== @@ -155,12 +155,12 @@ ITrafficGenerator start_cont_traffic(traffic, time, framerate) stop_cont_traffic(self): - send_rfc2544_throughput(traffic, trials, duration, lossrate) - start_rfc2544_throughput(traffic, trials, duration, lossrate) + send_rfc2544_throughput(traffic, tests, duration, lossrate) + start_rfc2544_throughput(traffic, tests, duration, lossrate) wait_rfc2544_throughput(self) - send_rfc2544_back2back(traffic, trials, duration, lossrate) - start_rfc2544_back2back(traffic, , trials, duration, lossrate) + send_rfc2544_back2back(traffic, tests, duration, lossrate) + start_rfc2544_back2back(traffic, , tests, duration, lossrate) wait_rfc2544_back2back() Note ``send_xxx()`` blocks whereas ``start_xxx()`` does not and must be followed by a subsequent call to ``wait_xxx()``. diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst index d807590d..b5f47998 100755 --- a/docs/userguide/testusage.rst +++ b/docs/userguide/testusage.rst @@ -396,7 +396,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. @@ -526,7 +526,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' diff --git a/docs/userguide/yardstick.rst b/docs/userguide/yardstick.rst index 3d249e1b..ec306d57 100755 --- a/docs/userguide/yardstick.rst +++ b/docs/userguide/yardstick.rst @@ -130,7 +130,7 @@ argument. Following options are supported: - **bidirectional** - specifies if traffic will be uni (False) or bi-directional (True); Default: False - **iload** - specifies frame rate; Default: 100 -- **rfc2544_trials** - specifies the number of trials performed for each packet +- **rfc2544_tests** - specifies the number of tests performed for each packet size - **multistream** - specifies the number of simulated streams; Default: 0 (i.e. multistream feature is disabled) |