aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguide/testusage.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-03-15vpp: Initial support of VPP vSwitchMartin Klozik1-5/+44
Support of VPP was implemented into VSPERF. Initial implementation uses step driven testcases to configure P2P, PVP and PVVP network scenarios. These testcases were prepared for three RFC2544 traffic types, i.e. throughput, continuous stream and back to back. VPP configuration is driven by new configuration option VSWITCH_VPP_ARGS. It is possible to use three types of l2 port connection supported by VPP, i.e. l2 xconnect (default), l2patch and l2 bridge features. Configuration is driven by parameter VSWITCH_VPP_L2_CONNECT_MODE. JIRA: VSPERF-495 Change-Id: Idebef9b10fb0d70796adb3405fec77302de00a7e Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-30docs: Remove hyperlinks to docs in artifactsMartin Klozik1-33/+16
It is possible to use sphinx cross referencing feature in case, that only one level of toctree is used. Thus documentation was reorganized to utilize just one top level index with toctree. After that it was possible to use rst native syntax to create a cross links among vsperf documentation chapters. As a result only 2 hyperlinks to the yardstick documentation are version specific. JIRA: VSPERF-442 Change-Id: I15c2f53922e88765506448de61af4a299f5d53c5 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com> Reviewed-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-24docs: Installation doc updatedMartin Klozik1-0/+0
Documentation was updated as follows: * description of vsperf downloading was added * VNF section was updated * additions to installation and virtualnev related parts * file permissions of all documentaton files was unified on 644 * README.md was updated with links to doc files and online docs * 3rd_party/readme was renamed and updated to follow markdown syntax JIRA: VSPERF-441 Change-Id: I648c6a8f0bb283bbc0875fd6fecd2539ca0c9056 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com>
2017-01-18Merge "mrg_buff_doc: Add documentation on mergable buffer option"Martin Klozik1-0/+38
2017-01-18mrg_buff_doc: Add documentation on mergable buffer optionChristian Trautman1-0/+38
Adds section about mergable buffers option to testusage doc. Also adds drive boot type info into gotchas section of testusage doc. JIRA: VSPERF-459 Change-Id: I159273502663dd29f4847b0737535009a42e430d Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2017-01-16traffic: Configurable traffic detailsMartin Klozik1-24/+7
Traffic generated by traffic generator is based on default values and their modifications specific to particular testing scenario. Traffic default values were defined inside VSPERF code and it was not possible to change them. This patch introduces new TRAFFIC dictionary inside 03_traffic.conf. Thus user can modify any of TRAFFIC values either in configuration file or by CLI or by 'Parameters' section of testcase definition. Following CLI options were obsoleted by this patch: 'bidirectional', 'traffic_type', 'iload', 'multistream', 'stream_type' and 'pre-installed_flows' Following CLI option was renamed to be consistent with other options: 'tunnel_type' => 'TUNNEL_TYPE' Following sections of testcase definition were obsoleted: "Traffic Type", "biDirectional", "MultiStream", "Stream Type", "Pre-installed Flows", "Flow Type" and "iLoad" New TRAFFIC dictionary should be used instead of old CLI options and old testcase definition sections. Testcase definitons, yardstick sample testcases and documentation were updated to reflect configuration changes. JIRA: VSPERF-433 Change-Id: I03a388c766491d5688e715f6d7b51e8e0377ec27 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: <sridhar.rao@spirent.com>
2017-01-13testpmd_pvp: Adds pkt_fwd to allow pvp topology testingChristian Trautman1-2/+52
Requires DPDK 16.11 or greater to support vdev flags. Initial support for TestPMD to support guests. Allows vsperf to execute TestPMD as a switch for pvp test scenarios. Can be increased in functionality later to support multiple guest configs. JIRA: VSPERF-406 Change-Id: I67a5a355c990ca6cfcbb5845a2beaf1c1f21f5f0 Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-12-07conf:Traffic-type naming convention and consistencySridhar K. N. Rao1-4/+5
Following changes are added following first review 1. Descriptions in integration/01_testcases.conf 2. Comment in conf/01_testcases.conf 3. Checking all cases of traffic types in traffic_controller_rfc2544.py 4. Removing whitespaces 5. Missing changes (throughput->rfc2544_throughput) 6. Syntax error in core/traffic_controller_rfc2544.py Currently the traffic-type values that are provided as part of the test case definition needs some fix to support additional traffic - apart from rfc2544. The Current and the proposed changed is summarized in the below table: |--------------------------------------------------------------------| | Parameter | Existing traffic_type value | Changed to | ---------------------------------------------------------------------- | Throughput | rfc2544 OR throughput | rfc2544_throughput | ---------------------------------------------------------------------- | Back2Back | back2back | rfc2544_back2back | ---------------------------------------------------------------------- | Continuous | continuous | rfc2544_continuous | ---------------------------------------------------------------------- JIRA: VSPERF-420 Change-Id: I22bd897f6389d2b568a6a3735c67f0003e813445 Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
2016-11-09cli: Modify configuration via CLIMartin Klozik1-25/+65
In the past, only a few configuration parameters could be modified via --test-params CLI argument and it was not easy to find out their complete list. This patch adds support for generic modification of any configuration parameter via CLI argument --test-params or by "Parameters" section of testcase definition. Thus it is possible to customize a vsperf configuration environment per testcase or for each vsperf execution. Old CLI parameters duration, pkt_sizes, rfc2544_tests and rfc2889_trials were renamed to TRAFFICGEN_DURATION, TRAFFICGEN_PKT_SIZES, TRAFFICGEN_RFC2544_TESTS and TRAFFICGEN_RFC2889_TRIALS to be consistent with other configuration parameters. JIRA: VSPERF-375 Change-Id: I50a1f4ff7250d754aa8af0295a9c7c1be8151175 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: <sridhar.rao@spirent.com>
2016-10-24guest_binding: Add dpdk driver binding options for guestsChristian Trautman1-0/+32
Adds uio_pci_generic and vfio_no_iommu options for guest driver binding. In case of SR-IOV tests with guests attached and uio_pci_generic is selected the option will be modified to use igb_uio instead as uio_pci_generic is not supported. JIRA: VSPERF-397 Change-Id: I56003addacc8bf0d024cce35d41b00dd0baa8cbc signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-10-17testpmd: Simplify GUEST's testpmd configurationMartin Klozik1-115/+110
Testpmd has a lot of parameters and vsperf was able to modify only a few of them through dedicated GUEST's specific configuration options. Old configuration options were replaced by one generic GUEST_TESTPMD_PARAMS, which allows to modify any of existing testpmd parameters. Detection of testpmd execution was changed to be independent on TXQ flags setting. Documentation was modified to reflect GUEST_TESTPMD change. Also doc formatting was fixed at several places. JIRA: VSPERF-380 Change-Id: Ie0bf290320f3b22ef6be6b55ed553235bbcb4aff Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com>
2016-10-11vsperf: launch should not depend on current $PWDOtto Sabart1-0/+3
JIRA: VSPERF-392 Change-Id: I44866b7d3298617003b87b015eb08bf32c4014f7 Signed-off-by: Otto Sabart <osabart@redhat.com>
2016-10-09CLI: add Multiqueue params.Antonio Fischetti1-0/+12
This patch implements the following new CLI parameters that can be used in the --test-params list. 1. guest_nic_queues, which overrides all GUEST_NIC_QUEUES values 2. guest_testpmd_txq, which overrides all GUEST_TESTPMD_TXQ 3. guest_testpmd_rxq, which overrides all GUEST_TESTPMD_RXQ 4. guest_testpmd_nb_cores, which overrides all GUEST_TESTPMD_NB_CORES values 5. guest_testpmd_cpu_mask, which overrides all GUEST_TESTPMD_CPU_MASK values 6. vswitch_dpdk_multi_queues, which overrides VSWITCH_DPDK_MULTI_QUEUES 7. guest_smp, which overrides all GUEST_SMP values 8. guest_core_binding, which overrides all GUEST_CORE_BINDING values When they are present in the CLI the corresponding settings from the configuration files will be overridden. As an example a usage can be: ./vsperf --test-params "guest_nic_queues=2;guest_testpmd_txq=1;\ guest_testpmd_rxq=1;guest_testpmd_nb_cores=1"... v2: rebase + rework to add other CLI params as suggested and update doc. v3: changes in 'testusage.rst' doc. JIRA: VSPERF-371 Change-Id: I140d6e068c1653d21aaa0df27532a48c4a12c151 Signed-off-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com>
2016-09-15paths: Support binary packagesMartin Klozik1-6/+7
Currently VSPERF supports OVS, DPDK and QEMU built from the source code only. In some cases it is required to support installation of these tools from binary packages available for given linux distribution. Thus VSPERF configuration and code was modified to suport both source and binary versions of tools. This can be configured perf tool, so various combinations of source and binary version are supported. Together with new configuration also a handling of kernel modules was modified to automatically detect and load module dependencies. JIRA: VSPERF-340 JIRA: VSPERF-339 Change-Id: I855cb438cbd8998bdc499613ea5e7de2526299d7 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Otto Sabart <osabart@redhat.com>
2016-09-01multi VM: Multi VMs in serial or parallelMartin Klozik1-12/+27
Support for deployment scenarios with any number of VMs in both serial and parallel configuration. Detailed content of the patch: * VswitchControllerPXP class for multi VM support * pvvpxx and pvpvxx deployments for xx VMs in serial respective parallel configuration * special GUEST_ options expansion to requested number of VMs; * support of GUEST_ options specific macros #VMINDEX, #MAC(), #IP() and #EVAL() * all GUEST specific options are turned to lists to be VM specific * support for VM with 1 NIC * support for VM with multiple NIC pairs; traffic is routed in serial or parallel between NIC paris based on deployment scenario * support for PVVP and PVPV scenarios using VMs with different numbers of NICs JIRA: VSPERF-361 Change-Id: I05bedbdfa9a81ea0166d9b03d83ae49d6cb8b19b Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com>
2016-08-24Vanilla_Multi_Queue: Add vanilla ovs multi-queue functionalityChristian Trautman1-19/+32
Adds multi-queue for vanilla OVS using virtio-net. TunTap ports will use multi_queue parameter when ports are created/deleted if guest nic queues are enabled and vswitch is ovs vanilla. Virtio net will now add guest nic queues to qemu command line if appropriate. Reworked multi-queue documentation to reflect these changes. Adds vhost net thread affinitization which is recommended when performing vanilla ovs multi-queue. Guests will require ethtool if using l2fwd or linux bridge as the loopback application when vanilla ovs multi-queue is enabled. Modified dpdk setting in vswitch conf to be better worded for separation from vanilla ovs multi-queue. Updated release and installation doc for new vloop image that includes required ethtool utility. JIRA: VSPERF-373 Change-Id: Idb550515190b1a93390308c11f54da368f962512 Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-08-18cuse: Remove vHost Cuse supportMartin Klozik1-26/+1
Support of vHost Cuse interface is not supported by OVS anymore, so it was removed also from VSPERF. Cuse can be used with older VSPERF release if needed. JIRA: VSPERF-376 Change-Id: Id786bddf5fa9dce5706a93de7b089707a60317cd Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com>
2016-08-16old_style_multi-queue: Allows for multi-queue with ovs <= 2.5.0Christian Trautman1-1/+10
Enables multi-queue option for OVS versions 2.5.0 or less with dpdk. Instead of enabling MQ on a port by port basis this sets the global MQ option after starting the ovs switch. JIRA: VSPERF-372 Change-Id: I245c76779695518d0005122d8214bbf3f141bb96 Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-08-12doc_fixup: Grammar and link fixes to documentationChristian Trautman1-1/+11
Fixes minor grammar and link issues. JIRA: VSPERF-349 Change-Id: Id8708aee5b099287b5c99e79ca6da9ab8778897f Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-08-05dpdk: Testpmd forwarding mode changes in v16.07Martin Klozik1-2/+5
Testpmd forwarding mode mac_retry was obsoleted in DPDK v16.07. Retry option is supported by multiple forwarding modes now. Former "mac_retry" mode can be replaced by "mac retry" construct. JIRA: VSPERF-333 Change-Id: I1563427985966264f07d10b1a8351784fe999d74 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: <bmichalo@redhat.com>
2016-06-29multi-queue: Add basic multi-queue functionalityChristian Trautman1-0/+58
Adds support for multi-queue using the following config. * VNF = QemuDpdkVhostUser * VSWITCH = OvsDpdkVhost * Guest Loopback as testpmd Adds CPU mask, nbcore, rxq, and txq options for testpmd. Adds option for guest nic multi-queue. Adds option for dpdkvhostuser and dpdk multi-queue enable JIRA: VSPERF-309 Change-Id: I5296fc18b430eace598d8c51620fc27a6c46a65e Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-05-06dpdk: Support new way of DPDK configuration in ovs-vswitchdMartin Klozik1-0/+10
Configuration of DPDK options in ovs-vswitchd has changed. Previously used option --dpdk was deprecated and all DPDK related options have to be configured through ovsdb via ovs-vsctl calls. VSPERF was modified to detect and use correct version of DPDK configuration. New configuration options should be put into VSWITCHD_DPDK_CONFIG dictionary. VSPERF classes specific to OVS were refactored. Change-Id: Ia3fad5906221439f477638f1f9734289dbf737bb JIRA: VSPERF-291 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2016-04-14sriov: Support of SRIOV and Qemu PCI passthroughMartin Klozik1-1/+61
Generic support of SRIOV has been added. Virtual interfaces can be used in multiplei scenarios instead of physical NICs. Virtual functions can be directly accessed from VM by PCI passthrough method. Another option is to use VFs with vSwtich to evaluate impact on performance. Additonal modifications: * Automatic detection of NIC details has been added to simplify configuration. * Obsoleted configuration options have been removed. * Logging usage within vsperf script was fixed. * Vsperf main was refactored and final cleanup function added. * Configurable forwarding mode of TestPMD executed inside VM. JIRA: VSPERF-198 Change-Id: I4a0d5d262b245d433b12419de79399fb5825a623 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2016-04-11docs: Fix param name test-param to test-paramsChristian Trautman1-4/+4
Repair of documentation and configuration files where test-params is incorrectly listed as test-param. JIRA: VSPERF-266 Change-Id: I6be6c387fd57338f5dc5fba2ca8e1438dada0852 Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-03-16tunneling: Vanilla OVS decapsulation testsDino Simeon Madarang1-0/+1
Add Vanilla OVS VXLAN/GRE/GENEVE decapsulation tests Recent changes: * Line wrap * Fix GENEVE IP settings * Add GRE and GENEVE steps to integration.rst * Add DUT_NIC1_MAC and DUT_NIC2_MAC * Remove unnecessary call to vswitch.set_tunnel_arp * Move optional VXLAN/GRE/GENEVE decap settings to a different section * Add tunnel type to report files md and rst * Fix typo error: l4 to L4 in conf/integration/03_traffic.conf Change-Id: I8a43521668d5870ec893aed1df49467f0a84a07d JIRA: VSPERF-180 Signed-off-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com> Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2016-03-08dpdk: enable vfio_pci supportMaryam Tahhan1-0/+37
Enable vfio_pci support for DPDK in the case where the end user doesn't want to use igb_uio. Changes: * Use generic functions to strip the path and .ko extension from the module to be inserted/removed. * Removed debug line in Modules_Manager. * Removed commented code. * Fixed all pylint issues. JIRA: VSPERF-249 Change-Id: I69c9077735879bcbf7ce5c970c1ec53c219e9f90 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-02-24Altering the heading levels to fit into the composite docs user guide.ChristopherPrice1-19/+30
Is required or it leaves the context of the document segment in the userguide. Change-Id: Idb476b7926ba0fce11ed3be54eaa6837e34bff66 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-23trafficgen: pause trafficgeneratorMaryam Tahhan1-0/+1
Add a mode to pause the traffic generator before transmission to bypass manual setup if required. Change-Id: Iad62a5e7cb83a311e2814d8a9ee2bc9b2d2ed4de Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com>
2016-02-21docs: Fixing typo in testusage.rst for port name example.Christian Trautman1-1/+1
JIRA: VSPERF-222 Signed-off-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
2016-02-16Altering the filename for autogenerationChristopherPrice1-0/+468
Updated the heading and moved to a new filename for composite docs. Added a link to the vsp userguide at the end of the doc. Change-Id: I416228be9347275bcd4c90e394678e4eb93198d4 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>