report: update to vpp performance release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 379072c..4f986eb 100644 (file)
@@ -1,3 +1,5 @@
+.. _vpp_performance_tests_release_notes:
+
 Release Notes
 =============
 
@@ -6,53 +8,42 @@ Changes in |csit-release|
 
 #. VPP 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 VPP 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.
-
-   - **L2patch Tests**: Tests measure performance of VPP L2patch, the
-     fastest L2 forwarding path implemented in VPP, that cross-links
-     RX and TX of two physical interfaces.
-
-   - **2-Node Tests**: A new baseline set of 2-node tests covering base
-     ip4, ip6, l2patch, l2bd, l2xc, running on new Xeon Skylake
-     testbeds.
-
-   - **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.
-
-   - **Simultaneous Multi-Threading**: SMT-aware detection of server
-     processor operation mode (HyperThreading enabled/disabled) with
-     associated compute resource configuration including thread
-     affinity, number of Rx queues and DPDK I/O mbufs. Tests are
-     automatically tagged during execution to indicate executed thread
-     configuration.
-
-   - **Intel Xeon Skylake Support**: Support for 2-Node and 3-Node
-     physical testbed topologies based on the new SuperMirco servers
-     each with two Intel Xeon Skylake Platinum processors. Full
-     Ansible playbooks refactor for quick server (re)installation and
-     reference pointers of configuration.
+   - **Intel Xeon Ice Lake**: Performance test data for these platforms
+     continues to be provided by external Intel benchmarking labs
+     executing |csit-release| tests. For details about the physical
+     setup see :ref:`tested_physical_topologies`.
+
+   - **AWS EC2 c5n**: Performance test data for AWS c5n instances has
+     been added to report for ip4, ip6 and ipsec tests.
+
+   - **Reduction of tests**: Removed certain test variations executed
+     iteratively for the report (as well as in daily and weekly
+     trending) due to physical testbeds overload.
+
+#. TEST FRAMEWORK
+
+   - **CSIT test environment** version has been updated to ver. 8, see
+     :ref:`test_environment_versioning`.
+
+   - **CSIT in AWS environment**: Completed CSIT automation support for
+     AWS c5n instances environment, including weekly performance 
+     trending tests execution.
+
+   - **CSIT PAPI support**: Due to issues with PAPI performance, and
+     deprecation of VAT, CLI is used in CSIT for many VPP scale tests.
+     See known issues below.
+
+   - **General Code Housekeeping**: Ongoing code optimizations and bug
+     fixes.
 
 #. PRESENTATION AND ANALYTICS LAYER
 
-   - **Performance trending**: Further improvements of continuous
-     performance trending, anomaly detection and analysis.
+   - **Graphs improvements**: Updated Packet Latency graphs,
+     see :ref:`latency_methodology`.
 
-#. TEST FRAMEWORK OPTIMIZATIONS
+.. raw:: latex
 
-   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
-     removal of redundant RF keywords.
+    \clearpage
 
 .. _vpp_known_issues:
 
@@ -61,46 +52,45 @@ Known Issues
 
 List of known issues in |csit-release| for VPP performance tests:
 
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| #  | JiraID                                  | Issue Description                                                                                                               |
-+====+=========================================+=================================================================================================================================+
-| 1  | `CSIT-570                               | Sporadic (1 in 200) NDR discovery test failures on x520. DPDK reporting rx-errors, indicating L1 issue.                         |
-|    | <https://jira.fd.io/browse/CSIT-570>`_  | Suspected issue with HW combination of X710-X520 in LF testbeds. Not observed outside of LF testbeds.                           |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 2  | `VPP-1361                               | High failure rate of api call sw_interface_set_flags [admin-up|link-up].                                                        |
-|    | <https://jira.fd.io/browse/VPP-1361>`_  | Failure rate: 30-40% of tests failing due to interfaces not in link-up state after API call sw_interface_set_flags.             |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 3  | `CSIT-1234                              | VPP IPSecHW scale interface mode 1core, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04.        |
-|    | <https://jira.fd.io/browse/CSIT-1234>`_ | ip4ipsecscale1000tnl-ip4base-int 1core CSIT-18.07/18.04 relative change: NDR -31%, PDR -32%, MRR -38%.                          |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 4  | `CSIT-1242                              | VPP xl710 ip4base test 1core, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04.                  |
-|    | <https://jira.fd.io/browse/CSIT-1242>`_ | xl710 ip4base 1core CSIT-18.07/18.04 relative change: NDR -29%, high stdev.                                                     |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 5  | `CSIT-1243                              | VPP nat44 base test 2core, low NDR and PDR 64B throughput in 3n-skx testbeds, compared to 3n-hsw testbeds.                      |
-|    | <https://jira.fd.io/browse/CSIT-1243>`_ | ip4base-nat44 2core 3n-skx/3n-hsw relative change: NDR -19%, PDR -22%.                                                          |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 6  | `CSIT-1244                              | VPP lispip4 base test 2core, low NDR and PDR 64B throughput in 3n-skx testbeds, compared to 3n-hsw testbeds.                    |
-|    | <https://jira.fd.io/browse/CSIT-1244>`_ | ip4lispip4-ip4base 2core 3n-skx/3n-hsw relative change: NDR -11%, PDR -18%.                                                     |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 7  | `CSIT-1245                              | VPP srv6proxy-stat and srv6proxy-masq, much higher NDR and PDR 78B throughput in 3n-hsw testbeds, in CSIT-18.07 vs. CSIT-18.04. |
-|    | <https://jira.fd.io/browse/CSIT-1245>`_ | Due to wrong test suite configuration in dynamic-proxy mode. Artefact of suite code refactoring.                                |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 8  | `CSIT-1246                              | Ligato K8S orchestrated tests are failing due to incompatibility of the latest released Ligato vpp-agent with VPP-18.07.        |
-|    | <https://jira.fd.io/browse/CSIT-1246>`_ | Past vpp-agent releases are not compatible either.                                                                              |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 9  | `CSIT-1253                              | VPP lbdpdk link bonding tests failing due to interfaces not coming up.                                                          |
-|    | <https://jira.fd.io/browse/CSIT-1253>`_ | VPP lbdpdk link bonding tests relying on DPDK functionality for bonding fail.                                                   |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 10 | `CSIT-1266                              | Because of wrong Multi Seq configuration in the suite "csit/tests/vpp/perf/ip4/2n1l-25ge2p1xxv710-ethip4-ip4base-mrr.robot",    |
-|    | <https://jira.fd.io/browse/CSIT-1266>`_ | the data generated by this suite is incorrect. The bug was fixed by the `patch 14440 <https://gerrit.fd.io/r/#/c/14440>`_.      |
-|    |                                         | The incorrect data will be replaced by new generated correct data.                                                              |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| 11 | `CSIT-1267                              | Because of the wrong NIC configuration in suites                                                                                |
-|    | <https://jira.fd.io/browse/CSIT-1267>`_ | tests/vpp/perf/vm_vhost/10ge2p1x710-1lbvpplacp-dot1q-l2bdbasemaclrn-eth-2vhostvr1024-1vm-mrr.robot,                             |
-|    |                                         | tests/vpp/perf/vm_vhost/10ge2p1x710-1lbvpplacp-dot1q-l2bdbasemaclrn-eth-2vhostvr1024-1vm-ndrpdr.robot,                          |
-|    |                                         | tests/vpp/perf/vm_vhost/10ge2p1x710-1lbvpplacp-dot1q-l2xcbase-eth-2vhostvr1024-1vm-mrr.robot,                                   |
-|    |                                         | tests/vpp/perf/vm_vhost/10ge2p1x710-1lbvpplacp-dot1q-l2xcbase-eth-2vhostvr1024-1vm-ndrpdr.robot                                 |
-|    |                                         | the data generated by this suites is incorrect.                                                                                 |
-|    |                                         | The bug was fixed by the `patch 14395 <https://gerrit.fd.io/r/#/c/14395>`_.                                                     |
-|    |                                         | The incorrect data will be replaced by new generated correct data.                                                              |
-+----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                         |
++====+=========================================+===========================================================================================================+
+|  1 | `CSIT-1782                              | Multicore AVF tests are failing when trying to create interface. The issue persists after FVL FW upgrade. |
+|    | <https://jira.fd.io/browse/CSIT-1782>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  2 | `CSIT-1763                              | Adapt ramp-up phase of nat44 tests for different frame sizes.                                             |
+|    | <https://jira.fd.io/browse/CSIT-1763>`_ | Currently ramp-up phase rate and duration values are correctly set for tests with 64B frame size.         |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  3 | `CSIT-1671                              | All CSIT scale tests can not use PAPI due to much slower performance compared to VAT/CLI (it takes much   |
+|    | <https://jira.fd.io/browse/CSIT-1671>`_ | longer to program VPP). This needs to be addressed on the PAPI side.                                      |
+|    +-----------------------------------------+ The usual PAPI library spends too much time parsing arguments, so even with async processing (hundreds of |
+|    | `VPP-1763                               | commands in flight over socket), the VPP configuration for large scale tests (millions of messages) takes |
+|    | <https://jira.fd.io/browse/VPP-1763>`_  | too long.                                                                                                 |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  4 | `CSIT-1789                              | AVF driver does not perform RSS in a deterministic way.                                                   |
+|    | <https://jira.fd.io/browse/CSIT-1789>`_ | This increases standard deviation of tests with small number of flows (mainly ipsec).                     |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  5 | `CSIT-1780                              | IPSEC SW async scheduler MRR tests failing with no traffic forwarded.                                     |
+|    | <https://jira.fd.io/browse/CSIT-1780>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  6 | `CSIT-1786                              | IP4 and IP6 scale tests failing with no traffic forwarded.                                                |
+|    | <https://jira.fd.io/browse/CSIT-1786>`_ | Issue reported to VPP devs.                                                                               |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  7 | `CSIT-1785                              | NAT44ED tests failing to establish all TCP sessions.                                                      |
+|    | <https://jira.fd.io/browse/CSIT-1785>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+|  8 | `CSIT-1791                              | Performance regression in RDMA tests, due to CSIT environment changes.                                    |
+|    | <https://jira.fd.io/browse/CSIT-1791>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+
+Root Cause Analysis for Performance Changes
+-------------------------------------------
+
+List of RCAs in |csit-release| for VPP performance changes:
+
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| #  | JiraID                                  | Issue Description                                                                                         |
++====+=========================================+===========================================================================================================+
+|  1 | `VPP-1972                               | One VPP change has decreased performance of NAT44ed processing, mostly slow path.                         |
+|    | <https://jira.fd.io/browse/VPP-1972>`_  |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+