report 1807: list and table formatting fixes.
[csit.git] / docs / report / dpdk_performance_tests / csit_release_notes.rst
index 363c2e7..bd89657 100644 (file)
@@ -4,99 +4,166 @@ Release Notes
 Changes in |csit-release|
 -------------------------
 
-No code changes apart from bug fixes.
+#. **DPDK performance tests**
+
+   - **MRR Throughput**: MRR (Maximum Receive Rate) test code has now
+     configurable trial duration and number of consecutive executions.
+     Coverage of MRR tests has been extended across more test
+     scenarios. MRR tests are used for continuous performance trending
+     and for comparison between DPDK releases.
+
+   - **MLRsearch Throughput**: MLRsearch algorithm has been introduced
+     for all NDR and PDR throughput tests. All tests that previously
+     used binary search got converted to MLRsearch. Coverage of NDR/PDR
+     tests has been extended across more test scenarios.
+
+   - **2-Node Tests**: A new set of 2-node tests covering DPDK Testpmd
+     and L3fwd, running on new Xeon Skylake testbeds.
+
+   - **More NICs**: Increased coverage of NIC models tested: Intel-
+     xxv710-da2, Intel-x710-da4.
+
+   - **Generated tests**: Simplified and unified test structure, semi-
+     autogenerated by generator script. Test generator is currently
+     able to create test combinations with various frame size and
+     cores combinations. All existing test cases were converted to new
+     format.
+
+#. **Presentation and Analytics Layer**
+
+   - **Performance trending**: Added continuous performance trending with
+     anomaly detection and analysis for DPDK.
 
 Performance Changes
 -------------------
 
-Relative performance changes in measured packet throughput in |csit-release|
-are calculated against the results from |csit-release-1|
-report. Listed mean and standard deviation values are computed based on
-a series of the same tests executed against respective VPP releases to
-verify test results repeatability, with percentage change calculated for
-mean values. Note that the standard deviation is quite high for a small
-number of packet throughput tests, what indicates poor test results
-repeatability and makes the relative change of mean throughput value not
-fully representative for these tests. The root causes behind poor
-results repeatability vary between the test cases.
+Relative performance changes in measured NDR, PDR and MRR packet
+throughput in |csit-release| are calculated against the test results
+from |csit-release-1| report, for tests running on 3-Node Intel Xeon
+Haswell testbeds (3n-hsw) in 1-core, 2-core and 4-core (MRR only)
+configurations.
+
+Listed mean and standard deviation values are computed based on a series
+of the same tests executed against respective VPP releases to verify
+test results repeatability, with percentage change calculated for mean
+values.
 
 NDR Changes
 ~~~~~~~~~~~
 
-NDR throughput changes between releases are available in a
-CSV and pretty ASCII formats:
+NDR throughput changes between releases are available in CSV and pretty
+ASCII formats:
 
-  - `csv format for 1t1c <../_static/dpdk/performance-changes-1t1c-ndr.csv>`_,
-  - `csv format for 2t2c <../_static/dpdk/performance-changes-2t2c-ndr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/dpdk/performance-changes-1t1c-ndr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/dpdk/performance-changes-2t2c-ndr.txt>`_.
+  - `CSV 1t1c NDR changes <../_static/dpdk/performance-changes-1t1c-ndr.csv>`_,
+  - `CSV 2t2c NDR changes <../_static/dpdk/performance-changes-2t2c-ndr.csv>`_,
+  - `ASCII 1t1c NDR changes <../_static/dpdk/performance-changes-1t1c-ndr.txt>`_,
+  - `ASCII 2t2c NDR changes <../_static/dpdk/performance-changes-2t2c-ndr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor dpdk performance job 3n-hsw`_
-    with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip
+    with RF result
+    files csit-dpdk-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
 PDR Changes
 ~~~~~~~~~~~
 
-PDR throughput changes between releases are available in a
-CSV and pretty ASCII formats:
+PDR throughput changes between releases are available in CSV and pretty
+ASCII formats:
 
-  - `csv format for 1t1c <../_static/dpdk/performance-changes-1t1c-pdr.csv>`_,
-  - `csv format for 2t2c <../_static/dpdk/performance-changes-2t2c-pdr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/dpdk/performance-changes-1t1c-pdr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/dpdk/performance-changes-2t2c-pdr.txt>`_.
+  - `CSV 1t1c PDR changes <../_static/dpdk/performance-changes-1t1c-pdr.csv>`_,
+  - `CSV 2t2c PDR changes <../_static/dpdk/performance-changes-2t2c-pdr.csv>`_,
+  - `ASCII 1t1c PDR changes <../_static/dpdk/performance-changes-1t1c-pdr.txt>`_,
+  - `ASCII 2t2c PDR changes <../_static/dpdk/performance-changes-2t2c-pdr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor dpdk performance job 3n-hsw`_
-    with Robot Framework result
+    with RF result
+    files csit-dpdk-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
+
+MRR Changes
+~~~~~~~~~~~
+
+MRR throughput changes between releases are available in CSV and pretty
+ASCII formats:
+
+  - `CSV 1t1c MRR changes <../_static/dpdk/performance-changes-1t1c-mrr.csv>`_,
+  - `CSV 2t2c MRR changes <../_static/dpdk/performance-changes-2t2c-mrr.csv>`_,
+  - `CSV 4t4c MRR changes <../_static/dpdk/performance-changes-4t4c-mrr.csv>`_,
+  - `ASCII 1t1c MRR changes <../_static/dpdk/performance-changes-1t1c-mrr.txt>`_,
+  - `ASCII 2t2c MRR changes <../_static/dpdk/performance-changes-2t2c-mrr.txt>`_,
+  - `ASCII 4t4c MRR changes <../_static/dpdk/performance-changes-4t4c-mrr.txt>`_.
+
+.. note::
+
+    Test results have been generated by
+    `FD.io test executor dpdk performance job 3n-hsw`_,
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
-Comparison Across Testbeds
---------------------------
+Skx vs. Hsw Comparison
+----------------------
 
-Relative performance changes in measured packet throughputon 3-Node Skx testbed
+Relative performance changes in measured packet throughput on 3-Node Skx testbed
 are calculated against the results measured on 3-Node Hsw testbed.
 
-NDR Changes
-~~~~~~~~~~~
+NDR Comparison
+~~~~~~~~~~~~~~
 
-NDR changes between testbeds are available in a
-CSV and pretty ASCII formats:
+NDR throughput changes between testbeds are available in a CSV and pretty ASCII
+formats:
 
-  - `csv format for ndr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
-  - `pretty ASCII format for ndr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
+  - `CSV 1c NDR comparison <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-ndr.csv>`_,
+  - `ASCII 1c NDR comparison <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-ndr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor dpdk performance job 3n-hsw`_ and
     `FD.io test executor dpdk performance job 3n-skx`_
-    with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip
+    with RF result
+    files csit-dpdk-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
-PDR Changes
-~~~~~~~~~~~
+PDR Comparison
+~~~~~~~~~~~~~~
+
+PDR throughput changes between testbeds are available in a CSV and pretty ASCII
+formats:
+
+  - `CSV 1c PDR comparison <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
+  - `ASCII 1c PDR comparison <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
 
-PDR throughput changes between testbeds are available in a
+.. note::
+
+    Test results have been generated by
+    `FD.io test executor dpdk performance job 3n-hsw`_ and
+    `FD.io test executor dpdk performance job 3n-skx`_
+    with RF result
+    files csit-dpdk-perf-|srelease|-\*.zip
+    `archived here <../_static/archive/>`_.
+
+MRR Comparison
+~~~~~~~~~~~~~~
+
+MRR throughput changes between testbeds are available in a
 CSV and pretty ASCII formats:
 
-  - `csv format for pdr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-pdr.csv>`_,
-  - `pretty ASCII format for pdr <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-pdr.txt>`_.
+  - `CSV 1c MRR comparison <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-mrr.csv>`_,
+  - `ASCII 1c MRR comparison <../_static/dpdk/performance-compare-testbeds-3n-hsw-3n-skx-mrr.txt>`_.
 
 .. note::
 
     Test results have been generated by
     `FD.io test executor dpdk performance job 3n-hsw`_ and
     `FD.io test executor dpdk performance job 3n-skx`_
-    with Robot Framework result
+    with RF result
     files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../_static/archive/>`_.
 
@@ -108,10 +175,5 @@ Here is the list of known issues in |csit-release| for Testpmd performance tests
 +---+---------------------------------------------------+------------+-----------------------------------------------------------------+
 | # | Issue                                             | Jira ID    | Description                                                     |
 +---+---------------------------------------------------+------------+-----------------------------------------------------------------+
-| 1 | Testpmd in 1t1c and 2t2c setups - large variation | CSIT-569   | Suspected NIC firmware or DPDK driver issue affecting NDR       |
-|   | of discovered NDR throughput values across        |            | throughput. Applies to XL710 and X710 NICs, no issues observed  |
-|   | multiple test runs with xl710 and x710 NICs.      |            | on x520 NICs.                                                   |
-+---+---------------------------------------------------+------------+-----------------------------------------------------------------+
-| 2 | Lower than expected NDR throughput with xl710     | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR       |
-|   | and x710 NICs, compared to x520 NICs.             |            | throughput. Applies to XL710 and X710 NICs.                     |
+|   | No known issues                                   |            |                                                                 |
 +---+---------------------------------------------------+------------+-----------------------------------------------------------------+