Report: vpp and dpdk rls notes updates.
[csit.git] / docs / report / dpdk_performance_tests / csit_release_notes.rst
index d84b4e2..7f190ab 100644 (file)
@@ -4,176 +4,57 @@ Release Notes
 Changes in |csit-release|
 -------------------------
 
-#. **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 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 CSV and pretty
-ASCII formats:
-
-  - `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 RF result
-    files csit-dpdk-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
-
-PDR Changes
-~~~~~~~~~~~
-
-PDR throughput changes between releases are available in CSV and pretty
-ASCII formats:
-
-  - `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 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/>`_.
-
-Skx vs. Hsw Comparison
-----------------------
-
-Relative performance changes in measured packet throughput on 3-Node Skx testbed
-are calculated against the results measured on 3-Node Hsw testbed.
-
-NDR Comparison
-~~~~~~~~~~~~~~
-
-NDR throughput changes between testbeds are available in a CSV and pretty ASCII
-formats:
-
-  - `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 RF result
-    files csit-dpdk-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
-
-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>`_.
-
-.. 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 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 RF result
-    files csit-vpp-perf-|srelease|-\*.zip
-    `archived here <../_static/archive/>`_.
+#. DPDK PERFORMANCE TESTS
+
+   - **Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds**: Testpmd and
+     L3fwd performance test data is not included in this report
+     version. This is due to the lower performance and behaviour
+     inconsistency of these systems following the upgrade of processor
+     microcode packages (skx ucode 0x2000064, clx ucode 0x500002c) as
+     part of updating Ubuntu 18.04 LTS kernel version. Tested VPP and
+     DPDK applications (L3fwd) are affected. Skx and Clx test data
+     will be added in subsequent maintenance report version(s) once
+     the issue is resolved. See :ref:`dpdk_known_issues`.
+
+#. DPDK RELEASE VERSION CHANGE
+
+   - |csit-release| tested |dpdk-release|, as used by |vpp-release|.
+
+#. TEST ENVIRONMENT
+
+   - **TRex Fortville NIC Performance**: Received FVL fix from Intel
+     resolving TRex low throughput issue. TRex per FVL NIC throughput
+     increased from ~27 Mpps to the nominal ~37 Mpps. For detail see
+     `CSIT-1503 <https://jira.fd.io/browse/CSIT-1503>`_ and `TRex-519
+     <https://trex-tgn.cisco.com/youtrack/issue/trex-519>`_].
+
+   - **New Intel Xeon Cascadelake Testbeds**: Added performance tests
+     for 2-Node-Cascadelake (2n-clx) testbeds with x710, xxv710 and
+     mcx556a-edat NIC cards.
+
+..
+    // Alternative Note for 1st Bullet when bad microcode Skx, Clx results are published
+    - **Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds**: Testpmd and
+      L3fwd performance test data is included in this report version,
+      but it shows lower performance and behaviour inconsistency of
+      these systems following the upgrade of processor microcode
+      packages (skx ucode 0x2000064, clx ucode 0x500002c) as part of
+      updating Ubuntu 18.04 LTS kernel version. Tested VPP and DPDK
+      applications (L3fwd) are affected. Skx and Clx test data will be
+      corrected in subsequent maintenance report version(s) once the
+      issue is resolved. See :ref:`vpp_known_issues`.
+
+.. _dpdk_known_issues:
 
 Known Issues
 ------------
 
-Here is the list of known issues in |csit-release| for Testpmd performance tests:
+List of known issues in |csit-release| for DPDK performance tests:
 
-+---+---------------------------------------------------+------------+-----------------------------------------------------------------+
-| # | Issue                                             | Jira ID    | Description                                                     |
-+---+---------------------------------------------------+------------+-----------------------------------------------------------------+
-|   | No known issues                                   |            |                                                                 |
-+---+---------------------------------------------------+------------+-----------------------------------------------------------------+
++----+------------------------------------------+----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                   | Issue Description                                                                                        |
++====+==========================================+==========================================================================================================+
+| 8  | `CSIT-1675                               | Intel Xeon 2n-skx, 3n-skx and 2n-clx testbeds behaviour and performance became inconsistent following    |
+|    | <https://jira.fd.io/browse/CSIT-1675>`_  | the upgrade to the latest Ubuntu 18.04 LTS kernel version (4.15.0-72-generic) and associated microcode   |
+|    |                                          | packages (skx ucode 0x2000064, clx ucode 0x500002c). VPP as well as DPDK L3fwd tests are affected.       |
++----+------------------------------------------+----------------------------------------------------------------------------------------------------------+