diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/design/vswitchperf_design.rst | 25 | ||||
| -rwxr-xr-x | docs/userguides/quickstart.rst | 46 |
2 files changed, 65 insertions, 6 deletions
diff --git a/docs/design/vswitchperf_design.rst b/docs/design/vswitchperf_design.rst index b8988458..e139a025 100755 --- a/docs/design/vswitchperf_design.rst +++ b/docs/design/vswitchperf_design.rst @@ -96,16 +96,19 @@ Other Configuration VM, vSwitch, Traffic Generator Independence =========================================== -VSPERF supports different vSwithes, Traffic Generators and VNFs by using -standard object-oriented polymorphism: +VSPERF supports different vSwithes, Traffic Generators, VNFs +and Forwarding Applications by using standard object-oriented polymorphism: * Support for vSwitches is implemented by a class inheriting from IVSwitch. * Support for Traffic Generators is implemented by a class inheriting from ITrafficGenerator. * Support for VNF is implemented by a class inheriting from IVNF. + * Support for Forwarding Applications is implemented by a class inheriting + from IPktFwd. By dealing only with the abstract interfaces the core framework can support -many implementations of different vSwitches, Traffic Generators and VNFs. +many implementations of different vSwitches, Traffic Generators, VNFs +and Forwarding Applications. IVSwitch -------- @@ -163,12 +166,22 @@ IVnf wait(guest_prompt) execute_and_wait (command) +IPktFwd +-------- + + .. code-block:: python + + class IPktFwd: + start() + stop() + + Controllers ----------- -Controllers are used in conjunction with abstract interfaces as way of -decoupling the control of vSwtiches, VNFs and TrafficGenerators from other -components. +Controllers are used in conjunction with abstract interfaces as way +of decoupling the control of vSwtiches, VNFs, TrafficGenerators +and Forwarding Applications from other components. The controlled classes provide basic primitive operations. The Controllers sequence and co-ordinate these primitive operation in to useful actions. For diff --git a/docs/userguides/quickstart.rst b/docs/userguides/quickstart.rst index e93a040f..caf3be04 100755 --- a/docs/userguides/quickstart.rst +++ b/docs/userguides/quickstart.rst @@ -343,6 +343,52 @@ 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. +Executing Packet Forwarding tests +----------------------------------- + +To select application, which will perform packet forwarding, +following configuration parameter should be configured: + + .. code-block:: console + + VSWITCH = 'none' + PKTFWD = 'TestPMD' + + or use --vswitch and --fwdapp + + ./vsperf --conf-file user_settings.py + --vswitch none + --fwdapp TestPMD + +Supported Packet Forwarding applications are: + + .. code-block:: console + + 'testpmd' - testpmd from dpdk + + +1. Update your ''10_custom.conf'' file to use the appropriate variables +for selected Packet Forwarder: + .. code-block:: console + + # testpmd configuration + TESTPMD_ARGS = [] + # packet forwarding mode: io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho + TESTPMD_FWD_MODE = 'csum' + # checksum calculation layer: ip|udp|tcp|sctp|outer-ip + TESTPMD_CSUM_LAYER = 'ip' + # checksum calculation place: hw (hardware) | sw (software) + TESTPMD_CSUM_CALC = 'sw' + # recognize tunnel headers: on|off + TESTPMD_CSUM_PARSE_TUNNEL = 'off' + +2. Run test: + + .. code-block:: console + + ./vsperf --conf-file <path_to_settings_py> + + Code change verification by pylint ---------------------------------- Every developer participating in VSPERF project should run |