test_spec: Adding vm2vm on separate hosts use case
[vswitchperf.git] / test_spec / vswitchperf_ltd.md
index 3ede185..07d49dc 100755 (executable)
@@ -306,6 +306,40 @@ The following represents possible deployments which can help to determine the pe
     +-----------------------------------------------------------------------------------------------------------+__|
 </code></pre>
 
+  - HOST 1(Physical port → virtual switch → VNF → virtual switch → Physical port) → HOST 2(Physical port → virtual switch → VNF → virtual switch → Physical port)
+
+<pre><code>
+
+ +--------------------------------------------+                 +------------------------------------------+
+ |   +---------------------------------+      |                 |    +--------------------------------+    |
+ |   |          Application            |      |                 |    |         Application            |    |
+ |   +----------------------------+----+      |                 |    +-------------------------+------+    |
+ |         ^                      |           |                 |           ^                  |           |
+ |         |                      v           |                 |           |                  v           |
+ | +-------+----------+  +------------------+ |                 | +---------+--------+  +----------------+ |
+ | | Logical port 0   |  | Logical port 1   | |                 | | Logical port 0   |  |Logical port 1  | |
+ +-+------------------+--+------------------+-+                 +-+------------------+--+------+---------+-+
+           ^                      |                                         ^                  |
+           |                      |                                         |                  |
+           |                      v                                         |                  v
+ +-+-------+----------+--+------------------+-+                 +-+---------+--------+--+----------------+-+
+ | | Logical port 0   |  |  Logical port 1  | |                 | | Logical port 0   |  | Logical port 1 | |
+ | +------------------+  +----------+-------+ |                 | +------------------+  +------+---------+ |
+ |          ^                       |         |                 |           ^                  |           |
+ |          |                       |         |                 |           |                  |           |
+ |          |       vswitch         v         |                 |           |     vswitch      v           |
+ | +--------+---------+  +------------------+ |                 | +---------+--------+  +----------------+ |
+ | |    phy port      |  |    phy port      | |                 | |  phy port        |  |  phy port      | |
+ +-+--------+---------+--+----------+-------+-+                 +-+---------+--------+--+------+---------+-+
+            ^                       +---------------------------------------+                  |
+            |                                                                                  v
+ +----------+----------------------------------------------------------------------------------+-----------+
+ |                                                                                                         |
+ |                                    traffic generator                                                    |
+ |                                                                                                         |
+ +---------------------------------------------------------------------------------------------------------+
+</code></pre>
+
 **Note:** For tests where the traffic generator and/or measurement receiver are implemented on VM and connected to the virtual switch through vNIC, the issues of shared resources and interactions between the measurement devices and the device under test must be considered.
 
  ####General Methodology:
@@ -334,6 +368,9 @@ The following represents possible deployments which can help to determine the pe
 
  **Note**: For throughput tests unless stated otherwise, test configurations should ensure that traffic traverses the installed flows through the switch, i.e. flows are installed and have an appropriate time out that doesn't expire before packet transmission starts.
 
+#####Flow Classification:
+Virtual switches group packets into flows by processing and matching particular header fields in the packet or frame, or by matching packets based on the input ports into the vSwitch. Thus a flow is considered to be a sequence of packets that have a shared set of header field values or have arrived on the same port. Performance results can vary based on the parameters the vSwitch uses to match for a flow. The recommended  flow classification parameters for any vSwitch performance tests are: the input port, the source IP address, the destination IP address and the Ethernet protocol type field. It is essential to increase the flow time-out time on a vSwitch before conducting any performance tests that do not measure the flow set-up time. Normally the first packet of a particular flow will install the flow in the vSwitch which adds an additional latency, subsequent packets of the same flow are not subject to this latency if the flow is already installed on the vSwitch.
+
  #####Test Priority
   Tests will be assigned a priority in order to determine which tests should be implemented immediately and which tests implementations can be deferred.
 
@@ -571,7 +608,7 @@ The starting point for defining the suite of tests for benchmarking the performa
   - Hardware details including:
     - Platform details.
     - Processor details.
-    - Memory information (type and size).
+    - Memory information (see below)
     - Number of enabled cores.
     - Number of cores used for the test.
     - Number of physical NICs, as well as their details (manufacturer, versions, type and the PCI slot they are plugged into).
@@ -594,6 +631,18 @@ The starting point for defining the suite of tests for benchmarking the performa
     - Number vNIC interrupt configuration.
     - Thread affinitization for the applications (including the vSwitch itself) on the host.
     - Details of Resource isolation, such as CPUs designated for Host/Kernel (isolcpu) and CPUs designated for specific processes (taskset).
+  - Memory Details
+    - Total memory
+    - Type of memory
+    - Used memory
+    - Active memory
+    - Inactive memory
+    - Free memory
+    - Buffer memory
+    - Swap cache
+    - Total swap
+    - Used swap
+    - Free swap
   - Test duration.
   - Number of flows.
   - Traffic Information:
@@ -687,6 +736,39 @@ The starting point for defining the suite of tests for benchmarking the performa
    - The [RFC5481] PDV form of delay variation on the traffic flow, using the 99th percentile.
    - CPU and memory utilization may also be collected as part of this test, to determine the vSwitch's performance footprint on the system.
 
+<br/>
+ - #####Test ID: LTD.Throughput.RFC2544.Profile
+
+  **Title**: RFC 2544 Throughput and Latency Profile
+
+  **Prerequisite Test**:
+
+  **Priority**:
+
+  **Description**:
+
+  This test reveals how throughput and latency degrades as the offered rate varies in the region of the DUT's maximum forwarding rate as determined by LTD.Throughput.RFC2544.PacketLossRatio (0% Packet Loss).  For example it can be used to determine if the degradation of throughput and latency as the offered rate increases is slow and graceful or sudden and severe.
+
+  The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams).
+
+  The offered traffic rate is described as a percentage delta with respect to the DUT's maximum forwarding rate as determined by LTD.Throughput.RFC2544.PacketLoss Ratio (0% Packet Loss case). A delta of 0% is equivalent to an offered traffic rate equal to the maximum forwarding rate; A delta of +50% indicates an offered rate half-way between the maximum forwarding rate and line-rate, whereas a delta of -50% indicates an offered rate of half the maximum rate. Therefore the range of the delta figure is natuarlly bounded at -100% (zero offered traffic) and +100% (traffic offered at line rate).
+
+  The following deltas to the maximum forwarding rate should be applied:
+
+   - -50%, -10%, 0%, +10% & +50%
+
+  **Expected Result**:
+  For each packet size a profile should be produced of how throughput and latency vary with offered rate.
+
+  **Metrics Collected**:
+
+  The following are the metrics collected for this test:
+
+   - The forwarding rate in Frames Per Second (FPS) and Mbps of the DUT for each delta to the maximum forwarding rate and for each frame size.
+   - The average latency for each delta to the maximum forwarding rate and for each frame size.
+   - CPU and memory utilization may also be collected as part of this test, to determine the vSwitch's performance footprint on the system.
+   - Any failures experienced (for example if the vSwitch crashes, stops processing packets, restarts or becomes unresponsive to commands) when the offered load is above Maximum Throughput MUST be recorded and reported with the results.
+
 <br/>
  - #####Test ID: LTD.Throughput.RFC2544.SystemRecoveryTime
   **Title**: RFC 2544 System Recovery Time Test
@@ -773,19 +855,15 @@ The starting point for defining the suite of tests for benchmarking the performa
 <br/>
 
   - #####Test ID: LTD.Throughput.RFC2544.SoakFrameModification
-  **Title**: RFC 2544 X% packet loss Throughput Soak Test with Frame Modification
+  **Title**: RFC 2544 Throughput Soak Test with Frame Modification
 
-  **Prerequisite Test** LTD.Throughput.RFC2544.PacketLossRatioFrameModification
+  **Prerequisite Test** LTD.Throughput.RFC2544.PacketLossRatioFrameModification (0% Packet Loss)
 
   **Priority**:
 
   **Description**:
 
-  The aim of this test is to understand the Throughput stability over an extended test duration in order to uncover any outliers. To allow for an extended test duration, the test should ideally run for 24 hours or, if this is not possible, for at least 6 hour. For this test, each frame size must be sent at the highest Throughput with X% packet loss, as determined in the prerequisite test. The default loss percentages to be tested are:
-    - X = 0%
-    - X = 10^-7%
-
-  Note: Other values can be tested if required by the user.
+  The aim of this test is to understand the throughput stability over an extended test duration in order to uncover any outliers. To allow for an extended test duration, the test should ideally run for 24 hours or, if this is not possible, for at least 6 hour. For this test, each frame size must be sent at the highest Throughput with 0% packet loss, as determined in the prerequisite test.
 
   During this test, the DUT must perform the following operations on the traffic flow:
 
@@ -793,11 +871,11 @@ The starting point for defining the suite of tests for benchmarking the performa
    - Perform any relevant address look-ups on the DUT's ingress ports.
    - Modify the packet header before forwarding the packet to the DUT's egress port. Packet modifications include:
      - Modifying the Ethernet source or destination MAC address.
-     - Modifying/adding a VLAN tag.
+     - Modifying/adding a VLAN tag (Recommended).
      - Modifying/adding a MPLS tag.
      - Modifying the source or destination ip address.
      - Modifying the TOS/DSCP field.
-     - Modifying the source or destination ports for UDP/TCP/SCTP  (Recommended).
+     - Modifying the source or destination ports for UDP/TCP/SCTP.
      - Modifying the TTL.
 
   **Expected Result**:
@@ -807,8 +885,7 @@ The starting point for defining the suite of tests for benchmarking the performa
   The following are the metrics collected for this test:
 
    - Throughput stability of the DUT.
-   - Any outliers in the Throughput stability.
-   - Any unexpected variation in Throughput stability.
+     - This means reporting the number of packets lost per time interval and reporting any time intervals with packet loss. An interval of 60s is suggested.
    - CPU and memory utilization may also be collected as part of this test, to determine the vSwitch's performance footprint on the system.
    - The [RFC5481] PDV form of delay variation on the traffic flow, using the 99th percentile.
 
@@ -884,7 +961,7 @@ The starting point for defining the suite of tests for benchmarking the performa
 
   **Description**:
 
-  This test measures the DUT's Max Forwarding Rate when the Offered Load is varied between the throughput and the Maximum Offered Load for fixed length frames at a fixed time interval. The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams). The throughput is the maximum offered load with 0% frame loss (measured by the prerequisite test), and the Maximum Offered Load (as defined by [RFC2885]) is _"the highest number of frames per second that an external source can transmit to a DUT/SUT for forwarding to a specified output interface or interfaces"_.
+  This test measures the DUT's Max Forwarding Rate when the Offered Load is varied between the throughput and the Maximum Offered Load for fixed length frames at a fixed time interval. The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams). The throughput is the maximum offered load with 0% frame loss (measured by the prerequisite test), and the Maximum Offered Load (as defined by [RFC2285]) is _"the highest number of frames per second that an external source can transmit to a DUT/SUT for forwarding to a specified output interface or interfaces"_.
 
   Traffic should be sent to the DUT at a particular rate (TX rate) starting with TX rate equal to the throughput rate. The rate of successfully received frames at the destination counted (in FPS). If the RX rate is equal to the TX rate, the TX rate should be increased by a fixed step size and the RX rate measured again until the Max Forwarding Rate is found.
 
@@ -992,10 +1069,11 @@ The starting point for defining the suite of tests for benchmarking the performa
   **Description**:
 
   The aim of this test is to determine whether the DUT will propagate any erroneous frames it receives or whether it is capable of filtering out the erroneous frames. Traffic should be sent with erroneous frames included within the flow at random intervals. Illegal frames that must be tested include:
-    - Undersize Frames.
     - Oversize Frames.
-    - CRC error frames.
-    - Fragment Frames.
+    - Undersize Frames.
+    - CRC Errored Frames.
+    - Dribble Bit Errored Frames
+    - Alignment Errored Frames
 
   The traffic flow exiting the DUT should be recorded and checked to determine if the erroneous frames where passed through the DUT.
 
@@ -1034,6 +1112,33 @@ The starting point for defining the suite of tests for benchmarking the performa
    - The forwarding rate of the DUT when forwarding broadcast traffic.
 
 <br/>
+ - #####Test ID: LTD.MemoryBandwidth.RFC2544.0PacketLoss.Scalability
+  **Title**: RFC 2544 0% loss Memory Bandwidth Scalability test
+
+  **Prerequisite Tests**:
+
+  **Priority**:
+
+  **Description**:
+
+  The aim of this test is to understand how the DUT's performance is affected by cache sharing and memory bandwidth between processes.
+
+  During the test all cores not used by the vSwitch should be running a memory intensive application. This application should read and write random data to random addresses in unused physical memory. The random nature of the data and addresses is intended to consume cache, exercise main memory access (as opposed to cache) and exercise all memory buses equally. Furthermore:
+  - the ratio of reads to writes should be recorded. A ratio of 1:1 SHOULD be used.
+  - the reads and writes MUST be of cache-line size and be cache-line aligned.
+  - in NUMA architectures memory access SHOULD be local to the core's node. Whether only local memory or a mix of local and remote memory is used MUST be recorded.
+  - the memory bandwidth (reads plus writes) used per-core MUST be recorded; the test MUST be run with a per-core memory bandwidth equal to half the maximum system memory bandwidth divided by the number of cores. The test MAY be run with other values for the per-core memory bandwidth.
+  - the test MAY also be run with the memory intensive application running on all cores.
+
+  Under these conditions the DUT's 0% packet loss throughput is determined as per LTD.Throughput.RFC2544.PacketLossRatio.
+
+  **Expected Result**:
+
+  **Metrics Collected**:
+
+  The following are the metrics collected for this test:
+
+  - The DUT's 0% packet loss throughput in the presence of cache sharing and memory bandwidth between processes.
 ----
 <a name="LatencyTests"></a>
 ####2.3.2 Packet Latency tests
@@ -1066,6 +1171,29 @@ The starting point for defining the suite of tests for benchmarking the performa
  **Deployment scenario**:
 
   - Physical → Virtual Switch → Physical.
+<br/>
+ - #####Test ID: LTD.PacketDelayVariation.RFC3393.Soak
+  **Title**: Packet Delay Variation Soak Test
+
+  **Prerequisite Tests**: LTD.Throughput.RFC2544.PacketLossRatio (0% Packet Loss)
+
+  **Priority**:
+
+  **Description**:
+
+  The aim of this test is to understand the distribution of packet delay variation for different frame sizes over an extended test duration and to determine if there are any outliers. To allow for an extended test duration, the test should ideally run for 24 hours or, if this is not possible, for at least 6 hour. For this test, each frame size must be sent at the highest possible throughput with 0% packet loss, as determined in the prerequisite test.
+
+  **Expected Result**:
+
+  **Metrics Collected**:
+
+  The following are the metrics collected for this test:
+
+   - The packet delay variation value for traffic passing through the DUT.
+   - The [RFC5481] PDV form of delay variation on the traffic flow, using the 99th percentile, for each 60s interval during the test.
+   - CPU and memory utilization may also be collected as part of this test, to determine the vSwitch's performance footprint on the system.
+
+
 <br/>
 ----
 <a name="ScalabilityTests"></a>
@@ -1131,7 +1259,7 @@ The starting point for defining the suite of tests for benchmarking the performa
 ----
 [RFC1242]:(http://www.ietf.org/rfc/rfc1242.txt)
 [RFC2544]:(http://www.ietf.org/rfc/rfc2544.txt)
-[RFC2885]:(http://www.ietf.org/rfc/rfc2885.txt)
+[RFC2285]:(http://www.ietf.org/rfc/rfc2285.txt)
 [RFC2889]:(http://www.ietf.org/rfc/rfc2889.txt)
 [RFC5481]:(http://www.ietf.org/rfc/rfc5481.txt)
 [RFC6201]:(http://www.ietf.org/rfc/rfc6201.txt)