IETFSummary: Expand IETF summary of LTD Sec 3
[vswitchperf.git] / test_spec / vswitchperf_ltd.md
old mode 100644 (file)
new mode 100755 (executable)
index 98b82d9..c850c10
@@ -166,38 +166,40 @@ The following represents possible deployments which can help to determine the pe
   - Physical port → virtual switch → VNF → virtual switch → VNF → virtual switch → physical port.
 
 <pre><code>
-                                                                                                                 __
-    +---------------------------------------------------+   +---------------------------------------------------+  |
-    |   Guest 1                                         |   |   Guest 2                                         |  |
-    |   +-------------------------------------------+   |   |   +-------------------------------------------+   |  |
-    |   |                 Application               |   |   |   |                 Application               |   |  |
-    |   +-------------------------------------------+   |   |   +-------------------------------------------+   |  |
-    |       ^                                  :        |   |       ^                                  :        |  |
-    |       |                                  |        |   |       |                                  |        |  |  Guest
-    |       :                                  v        |   |       :                                  v        |  |
-    |   +---------------+           +---------------+   |   |   +---------------+           +---------------+   |  |
-    |   | logical port 0|           | logical port 1|   |   |   | logical port 0|           | logical port 1|   |  |
-    +---+---------------+-----------+---------------+---+   +---+---------------+-----------+---------------+---+__|
-            ^                                  :                    ^                                  :
-            |                                  |                    |                                  |
-            :                                  v                    :                                  v         __
-    +---+---------------+----------+---------------+------------+---------------+-----------+---------------+---+  |
-    |   |     port 0    |          |     port 1    |            |     port 2    |           |     port 3    |   |  |
-    |   +---------------+          +---------------+            +---------------+           +---------------+   |  |
-    |       ^                                  :                    ^                                  :        |  |
-    |       |                                  |                    |                                  |        |  |  Host
-    |       :                                  +--------------------+                                  v        |  |
-    |   +--------------+                                                                    +--------------+    |  |
-    |   |   phy port   |                               vswitch                              |   phy port   |    |  |
-    +---+--------------+--------------------------------------------------------------------+--------------+----+__|
-               ^                                                                                    :
-               |                                                                                    |
-               :                                                                                    v
-    +-----------------------------------------------------------------------------------------------------------+
-    |                                                                                                           |
-    |                                              traffic generator                                            |
-    |                                                                                                           |
-    +-----------------------------------------------------------------------------------------------------------+
+
+                                                   __
+ +----------------------+  +----------------------+  |
+ |   Guest 1            |  |   Guest 2            |  |
+ |   +---------------+  |  |   +---------------+  |  |
+ |   |  Application  |  |  |   |  Application  |  |  |
+ |   +---------------+  |  |   +---------------+  |  |
+ |       ^       |      |  |       ^       |      |  |
+ |       |       v      |  |       |       v      |  |  Guests
+ |   +---------------+  |  |   +---------------+  |  |
+ |   | logical ports |  |  |   | logical ports |  |  |
+ |   |   0       1   |  |  |   |   0       1   |  |  |
+ +---+---------------+--+  +---+---------------+--+__|
+         ^       :                 ^       :
+         |       |                 |       |
+         :       v                 :       v       _
+ +---+---------------+---------+---------------+--+ |
+ |   |   0       1   |         |   3       4   |  | |
+ |   | logical ports |         | logical ports |  | |
+ |   +---------------+         +---------------+  | |
+ |       ^       |                 ^       |      | |  Host
+ |       |       L-----------------+       v      | |
+ |   +--------------+          +--------------+   | |
+ |   |   phy ports  | vSwitch  |   phy ports  |   | |
+ +---+--------------+----------+--------------+---+_|
+         ^       :                 ^       :
+         |       |                 |       |
+         :       v                 :       v
+ +--------------------------------------------------+
+ |                                                  |
+ |                traffic generator                 |
+ |                                                  |
+ +--------------------------------------------------+
+
 </code></pre>
 
   - Physical port → virtual switch → VNF.
@@ -542,11 +544,11 @@ The following represents possible deployments which can help to determine the pe
    - 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**:
@@ -565,17 +567,17 @@ The following represents possible deployments which can help to determine the pe
  - #####Test ID: LTD.Throughput.RFC2544.SystemRecoveryTime
   **Title**: RFC 2544 System Recovery Time Test
 
-  **Prerequisite Test**: N\A
+  **Prerequisite Test** LTD.Throughput.RFC2544.PacketLossRatio
 
   **Priority**:
 
   **Description**:
 
-  The aim of this test is to determine the length of time it takes the DUT to recover from an overload condition for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams), traffic should be sent to the DUT under normal conditions. During the duration of the test and while the traffic flows are passing though the DUT, at least one situation leading to an overload condition for the DUT should occur. The time from the start of the overload condition to when the DUT returns to normal operations should be measured to determine recovery time. Prior to overloading the DUT, one should record the average latency for 100 packets forwarded through the DUT.
+  The aim of this test is to determine the length of time it takes the DUT to recover from an overload condition for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams), traffic should be sent to the DUT under normal conditions. During the duration of the test and while the traffic flows are passing though the DUT, at least one situation leading to an overload condition for the DUT should occur. The time from the end of the overload condition to when the DUT returns to normal operations should be measured to determine recovery time. Prior to overloading the DUT, one should record the average latency for 10,000 packets forwarded through the DUT.
 
-  The suggested overload condition would be to transmit traffic at a very high frame rate to the DUT, for at least 60 seconds, then reduce the frame rate to the DUT by half; A number of time-stamps should be recorded: 
-    - Record the time-stamp at which the frame rate was halved and record a second time-stamp at the time of the last frame lost. The recovery time is the difference between the two timestamps.
-    - Record the average Latency for 100 frames after the last frame loss and continue to record average latency measurements for every 100 frames, when latency returns to pre-overload levels record the time-stamp.
+  The overload condition SHOULD be to transmit traffic at a very high frame rate to the DUT (150% of the maximum 0% packet loss rate as determined by LTD.Throughput.RFC2544.PacketLossRatio or line-rate whichever is lower), for at least 60 seconds, then reduce the frame rate to 75% of the maximum 0% packet loss rate. A number of time-stamps should be recorded:
+    - Record the time-stamp at which the frame rate was reduced and record a second time-stamp at the time of the last frame lost. The recovery time is the difference between the two timestamps.
+    - Record the average latency for 10,000 frames after the last frame loss and continue to record average latency measurements for every 10,000 frames, when latency returns to within 10% of pre-overload levels record the time-stamp.
 
   **Expected Result**:
 
@@ -627,7 +629,7 @@ The following represents possible deployments which can help to determine the pe
 
   **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:
+  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 hours. 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%
 
@@ -640,9 +642,9 @@ The following represents possible deployments which can help to determine the pe
   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.
 
 <br/>
 
@@ -684,6 +686,7 @@ The following represents possible deployments which can help to determine the pe
    - Any outliers in the Throughput stability.
    - Any unexpected variation in Throughput stability.
    - 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.
 
 <br/>
 
@@ -696,7 +699,13 @@ The following represents possible deployments which can help to determine the pe
 
   **Description**:
 
-  The aim of this test is to determine the length of time it takes the DUT to recover from a reset. For each frame size previously defined under [Default Test Parameters](#DefaultParams), traffic should be sent to the DUT under normal conditions. During the duration of the test and while the traffic flows are passing through the DUT, the DUT should be reset and the Reset time measured. The Reset time is the total time that a device is determined to be out of operation and includes the time to perform the reset and the time to recover from it (cf. [RFC6201]) 
+  The aim of this test is to determine the length of time it takes the DUT to recover from a reset.
+
+  Two reset methods are defined - planned and unplanned. A planned reset requires stopping and restarting the virtual switch by the usual 'graceful' method defined by it's documentation. An unplanned reset requires simulating a fatal internal fault in the virtual switch - for example by using kill -SIGKILL on a Linux environment.
+
+  Both reset methods SHOULD be exercised.
+
+  For each frame size previously defined under [Default Test Parameters](#DefaultParams), traffic should be sent to the DUT under normal conditions. During the duration of the test and while the traffic flows are passing through the DUT, the DUT should be reset and the Reset time measured. The Reset time is the total time that a device is determined to be out of operation and includes the time to perform the reset and the time to recover from it (cf. [RFC6201]).
 
   [RFC6201] defines two methods to measure the Reset time:
     - Frame-Loss Method: which requires the monitoring of the number of lost frames and calculates the Reset time based on the number of frames lost and the offered rate according to the following formula:
@@ -721,13 +730,14 @@ The following represents possible deployments which can help to determine the pe
   **Metrics collected**
 
   The following are the metrics collected for this test:
-   - Average Reset Time.
+   - Average Reset Time over the number of trials performed.
 
   Results of this test should include the following information:
+   - The reset method used.
    - Throughput in Fps and Mbps.
-   - Average Frame Loss.
-   - Average Reset Time in milliseconds.
-   - Number of trials.
+   - Average Frame Loss over the number of trials performed.
+   - Average Reset Time in milliseconds over the number of trials performed.
+   - Number of trials performed.
    - Protocol: IPv4, IPv6, MPLS, etc.
    - Frame Size in Octets
    - Port Media: Ethernet, Gigabit Ethernet (GbE), etc.
@@ -802,7 +812,7 @@ The following represents possible deployments which can help to determine the pe
 
   **Description**:
 
-  The aim of this test is to determine the address caching capacity of the DUT for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams). 
+  Please note this test is only applicable to switches that are capable of MAC learning. The aim of this test is to determine the address caching capacity of the DUT for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams). 
 
   In order to run this test the aging time, that is the maximum time the DUT will keep a learned address in its flow table, and a set of initial addresses, whose value should be >= 1 and <= the max number supported by the implementation must be known. Please note that if the aging time is configurable it must be longer than the time necessary to produce frames from the external source at the specified rate. If the aging time is fixed the frame rate must be brought down to a value that the external source can produce in a time that is less than the aging time.
 
@@ -832,7 +842,7 @@ The following represents possible deployments which can help to determine the pe
 
   **Description**:
 
-  The aim of this test is to determine the rate of address learning of the DUT for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams), traffic should be sent with each IPv4/IPv6 address incremented by one. The rate at which the DUT learns a new address should be measured. The maximum caching capacity from LTD.Memory.RFC2889.AddressCachingCapacity should be taken into consideration as the maximum number of addresses for which the learning rate can be obtained.
+  Please note this test is only applicable to switches that are capable of MAC learning. The aim of this test is to determine the rate of address learning of the DUT for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined under [Default Test Parameters](#DefaultParams), traffic should be sent with each IPv4/IPv6 address incremented by one. The rate at which the DUT learns a new address should be measured. The maximum caching capacity from LTD.Memory.RFC2889.AddressCachingCapacity should be taken into consideration as the maximum number of addresses for which the learning rate can be obtained.
 
   **Expected Result**:
   It may be worthwhile to report the behaviour when operating beyond address capacity - some DUTS may be more friendly to new addresses than others.
@@ -933,6 +943,67 @@ The following represents possible deployments which can help to determine the pe
 
   - Physical → Virtual Switch → Physical.
 <br/>
+----
+<a name="ScalabilityTests"></a>
+####2.3.3 Scalability tests
+
+  The general aim of these tests is to understand the impact of large flow table size and flow lookups on throughput.
+
+  The following list is not exhaustive but should indicate the type of tests that should be required. It is expected that more will be added.
+
+<br/>
+ - #####Test ID: LTD.Scalability.RFC2544.0PacketLoss
+
+  **Title**: RFC 2544 0% loss Scalability throughput test
+
+  **Prerequisite Test**:
+
+  **Priority**:
+
+  **Description**:
+
+  The aim of this test is to measure how throughput changes as the number of flows in the DUT increases.
+
+  For each frame size previously defined under [Default Test Parameters](#DefaultParams) and for each of the following number of flows:
+
+  - 1,000
+  - 2,000
+  - 2,000
+  - 4,000
+  - 8,000
+  - 16,000
+  - 32,000
+  - 64,000
+
+  The maximum 0% packet loss throughput should be determined in a manner identical to LTD.Throughput.RFC2544.PacketLossRatio.
+
+  **Expected Result**:
+
+  **Metrics Collected**:
+
+  The following are the metrics collected for this test:
+
+   - The maximum number of frames per second that can be forwarded at the specified number of flows and the specified frame size, with zero packet loss.
+<br/>
+
+<a name="SummaryList"></a>
+####2.3.9 Summary List of Tests
+- LTD.Throughput.RFC2544.PacketLossRatio
+- LTD.Throughput.RFC2544.PacketLossRatioFrameModification
+- LTD.Throughput.RFC2544.SystemRecoveryTime
+- LTD.Throughput.RFC2544.BackToBackFrames
+- LTD.Throughput.RFC2544.Soak
+- LTD.Throughput.RFC2544.SoakFrameModification
+- LTD.Throughput.RFC6201.ResetTime
+- LTD.Throughput.RFC2889.ForwardingRate
+- LTD.Throughput.RFC2889.ForwardPressure
+- LTD.Throughput.RFC2889.AddressCachingCapacity
+- LTD.Throughput.RFC2889.AddressLearningRate
+- LTD.Throughput.RFC2889.ErrorFramesFiltering
+- LTD.Throughput.RFC2889.BroadcastFrameForwarding
+- LTD.PacketLatency.InitialPacketProcessingLatency
+- LTD.Scalability.RFC2544.0PacketLoss
+
 ----
 [RFC1242]:(http://www.ietf.org/rfc/rfc1242.txt)
 [RFC2544]:(http://www.ietf.org/rfc/rfc2544.txt)