report: updated rls notes for vpp performance section
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 379072c..4e5280f 100644 (file)
@@ -6,53 +6,36 @@ 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.
+   - CSIT test environment is now versioned, with ver. 1 associated
+     with CSIT rls1908 git branch as of 2019-08-21, and ver. 2
+     associated with CSIT rls2001 and master git branches as of
+     2020-03-27.
 
-   - **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.
+   - To identify performance changes due to VPP code changes from
+     v20.01.0 to v20.05.0, both have been tested in CSIT environment
+     ver. 2 and compared against each other. All substantial
+     progressions has been marked up with RCA analysis. See
+     :ref:`vpp_compare_current_vs_previous_release` and
+     :ref:`vpp_known_issues`.
 
-   - **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.
+#. TEST FRAMEWORK
 
-   - **2-Node Tests**: A new baseline set of 2-node tests covering base
-     ip4, ip6, l2patch, l2bd, l2xc, running on new Xeon Skylake
-     testbeds.
+   - **CSIT PAPI support**: Due to issues with PAPI performance, VAT is
+     still used in CSIT for all VPP scale tests. See known issues below.
 
-   - **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.
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+     removal of redundant RF keywords and aligning of suite/test
+     setup/teardowns.
 
 #. PRESENTATION AND ANALYTICS LAYER
 
-   - **Performance trending**: Further improvements of continuous
-     performance trending, anomaly detection and analysis.
+   - **Graphs layout improvements**: Improved performance graphs layout
+     for better readibility and maintenance: test grouping, axis
+     labels, descriptions, other informative decoration.
 
-#. TEST FRAMEWORK OPTIMIZATIONS
+.. raw:: latex
 
-   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
-     removal of redundant RF keywords.
+    \clearpage
 
 .. _vpp_known_issues:
 
@@ -61,46 +44,70 @@ 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-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-662                                | 9000B packets not supported by NICs VIC1227 and VIC1387.                                                  |
+|    | <https://jira.fd.io/browse/VPP-662>`_   |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 3  | `CSIT-1498                              | Memif tests are sporadically failing on initialization of memif connection.                               |
+|    | <https://jira.fd.io/browse/CSIT-1498>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 4  | `VPP-1677                               | 9000B ip4 nat44: VPP crash + coredump.                                                                    |
+|    | <https://jira.fd.io/browse/VPP-1677>`_  | VPP crashes very often in case that NAT44 is configured and it has to process IP4 jumbo frames (9000B).   |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 5  | `CSIT-1591                              | 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-1499>`_ | longer to program VPP). This needs to be addressed on the PAPI side.                                      |
+|    +-----------------------------------------+                                                                                                           |
+|    | `VPP-1763                               |                                                                                                           |
+|    | <https://jira.fd.io/browse/VPP-1763>`_  |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 6  | `VPP-1675                               | IPv4 IPSEC 9000B packet tests are failing as no packet is forwarded.                                      |
+|    | <https://jira.fd.io/browse/VPP-1675>`_  | Reason: chained buffers are not supported.                                                                |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 7  | `CSIT-1593                              | IPv4 AVF 9000B packet tests are failing on 3n-skx while passing on 2n-skx.                                |
+|    | <https://jira.fd.io/browse/CSIT-1593>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 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.        |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 9  | `CSIT-1679                              | All 2n-clx VPP ip4 tests with xxv710 and avf driver are failing.                                          |
+|    | <https://jira.fd.io/browse/CSIT-1679>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 10 | `CSIT-1680                              | Some 2n-clx cx556a rdma tests are failing.                                                                |
+|    | <https://jira.fd.io/browse/CSIT-1680>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 11 | `CSIT-1699                              | Root Cause Analysis for CSIT-2001. Investigate high stdev of tests with VPP inside VM.                    |
+|    | <https://jira.fd.io/browse/CSIT-1699>`_ |                                                                                                           |
+|    +-----------------------------------------+                                                                                                           |
+|    | `CSIT-1704                              |                                                                                                           |
+|    | <https://jira.fd.io/browse/CSIT-1704>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 12 | `CSIT-1699                              | Root Cause Analysis for CSIT-2001. Identify cause of dot1q-l2xcbase progression.                          |
+|    | <https://jira.fd.io/browse/CSIT-1699>`_ |                                                                                                           |
+|    +-----------------------------------------+                                                                                                           |
+|    | `CSIT-1705                              |                                                                                                           |
+|    | <https://jira.fd.io/browse/CSIT-1705>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 13 | `CSIT-1699                              | Root Cause Analysis for CSIT-2001. Identify cause of avf-ip4scale regression.                             |
+|    | <https://jira.fd.io/browse/CSIT-1699>`_ |                                                                                                           |
+|    +-----------------------------------------+                                                                                                           |
+|    | `CSIT-1706                              |                                                                                                           |
+|    | <https://jira.fd.io/browse/CSIT-1706>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 14 | `CSIT-1699                              | Root Cause Analysis for CSIT-2001. Identify cause of progression in vhost-user tests with testpmd in VM.  |
+|    | <https://jira.fd.io/browse/CSIT-1699>`_ |                                                                                                           |
+|    +-----------------------------------------+                                                                                                           |
+|    | `CSIT-1707                              |                                                                                                           |
+|    | <https://jira.fd.io/browse/CSIT-1707>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
+| 15 | `CSIT-1699                              | Root Cause Analysis for CSIT-2001. Identify cause for avf-ip4base regression.                             |
+|    | <https://jira.fd.io/browse/CSIT-1699>`_ |                                                                                                           |
+|    +-----------------------------------------+                                                                                                           |
+|    | `CSIT-1708                              |                                                                                                           |
+|    | <https://jira.fd.io/browse/CSIT-1708>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+