Report: update known perf issues
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 4fdee97..74ab680 100644 (file)
@@ -4,160 +4,89 @@ Release Notes
 Changes in |csit-release|
 -------------------------
 
-#. **VPP performance tests**
+#. VPP PERFORMANCE TESTS
 
-   - *MRR tests* - New Maximum Receive Rate tests measure the packet
-     forwarding rate under the maximum load offered by traffic
-     generator over a set trial duration, regardless of packet loss.
-     MRR tests are used for continuous performance trending and for
-     comparison between releases.
+   - **Service density 2n-skx tests**: Added higher NF density tests with two
+     NFs' data-plane threads sharing a physical core. VPP IPv4 routing is now
+     used as a VNF payload similar to CNF tests.
 
-   - *Service Chaining with SRv6* - New SRv6 (Segment Routing IPv6) proxy
-     tests measure performance of SRv6 Endpoint fronting SR-unaware
-     appliance via masquerading (End.AM), dynamic proxy (End.AD) or
-     static proxy (End.AS) SR functions.
+   - **Soak Tests**: Optimized performamce soak tests framework
+     code for extended time duration tests and throughput discovery
+     at given PLR and at give total test time e.g. minutes, hours,
+     days, weeks. See updated
+     :ref:`test_methodology` section for more details.
 
-#. **Presentation and Analytics Layer**
+#. TEST FRAMEWORK
 
-   - *Performance trending* - Added continuous performance trending and
-     analysis. New Performance Trending and Performance Analysis jobs
-     executed regular throughput tests, with results being subsequently
-     analysed and trend and anomalies summarized and presented in VPP
-     Performance Dashboard and trendline graphs.
+   - **Qemu code refactor**: Complete code refactor of the key components of
+     QemuUtil.py and QemuManager.py (L1 and L2 KW counterparts). Added
+     implementation of kernel-image-kvm based VM replacing the previously used
+     NestedVM images. Added ability to run VPP as a payload in VNF.
 
-#. **Test Framework Optimizations**
+   - **CSIT PAPI Support**: Continued conversion of CSIT VAT L1 keywords to
+     PAPI L1 KWs in CSIT using VPP Python bindings. Redesign of key components
+     of PAPI Executor and PAPI history.
 
-   - *Performance tests efficiency* - Qemu build/install optimizations,
-     warmup phase handling, vpp restart handling. Resulted in improved
-     stability and reduced total execution time by 30% for single pkt
-     size e.g. 64B/78B.
-
-   - *General code housekeeping* - ongoing RF keywords optimizations,
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
      removal of redundant RF keywords.
 
-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 repeatibility, 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 repeatibility vary between the test cases.
-
-NDR Changes
-~~~~~~~~~~~
-
-NDR small packet throughput changes between releases are available in a
-CSV and pretty ASCII formats:
-
-  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-ndr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-ndr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-ndr.txt>`_.
-
-.. note::
-
-    Test results have been generated by
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.
-
-PDR Changes
-~~~~~~~~~~~
-
-NDR small packet throughput changes between releases are available in a
-CSV and pretty ASCII formats:
-
-  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-pdr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-pdr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-pdr.txt>`_.
-
-.. note::
-
-    Test results have been generated by
-    `FD.io test executor vpp performance jobs`_ with Robot Framework result
-    files csit-vpp-perf-|srelease|-\*.zip `archived here <../_static/archive/>`_.
-
-MRR Changes
-~~~~~~~~~~~
-
-MRR small packet throughput changes between releases are available in a
-CSV and pretty ASCII formats:
-
-  - `csv format for 1t1c <../_static/vpp/performance-changes-1t1c-mrr.csv>`_,
-  - `csv format for 2t2c <../_static/vpp/performance-changes-2t2c-mrr.csv>`_,
-  - `csv format for 4t4c <../_static/vpp/performance-changes-4t4c-mrr.csv>`_,
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-1t1c-mrr.txt>`_,
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-2t2c-mrr.txt>`_,
-  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-4t4c-mrr.txt>`_.
-
-.. note::
-
-    Test results have been generated by
-    `FD.io test executor vpp mrr jobs <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-mrr-daily-master/>`_
-    with Robot Framework result files csit-vpp-perf-mrr-daily-master__*__output.xml.gz
-    `archived here <https://docs.fd.io/csit/master/trending/_static/archive/>`_.
-
-Comparison Across Testbeds
---------------------------
-
-.. warning::
+   - **Test suite generator**: Added capability to generate suites for
+     different NIC models as well as throughput search algorithm types. Uses
+     base tests suites as source.
 
-    TODO: Add:
+   - **TOX verification**: Added verifications for test suite generator.
 
-    Table 1.
-    Test Case     3-Node Hsw    3-Node Skx    Skx vs. Hsw Delta [%]
+#. PRESENTATION AND ANALYTICS LAYER
 
-    Table 2.
-    Test Case     3-Node Skx    2-Node Skx    2-Node vs. 3-Node Delta [%]
+   - **Graphs Layout Improvements**: Improved performance graphs layout
+     for better readibility and maintenance: test grouping, axis
+     labels, descriptions, other informative decoration.
 
-Throughput Trending
--------------------
+..
+    #. MISCELLANEOUS
 
-In addition to reporting throughput changes between VPP releases, CSIT
-provides continuous performance trending for VPP master branch:
+       - **2n-dnv Tests (3rd Party)**: Published performance tests for 2n-
+         dnv (2-Node Atom Denverton) from 3rd party testbeds running FD.io
+         |csit-release| automated testing code.
+         Only graphs for Packet Throughput and Speedup Multi-core and not
+         for Packet Latency were published as there are no results for Packet
+         Latency available.
 
-#. `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_
-   - per VPP test case throughput trend, trend compliance and summary of
-   detected anomalies.
+.. raw:: latex
 
-#. `Trending Methodology <https://docs.fd.io/csit/master/trending/methodology/index.html>`_
-   - throughput test metrics, trend calculations and anomaly
-   classification (progression, regression, outlier).
+    \clearpage
 
-#. `Trendline Graphs <https://docs.fd.io/csit/master/trending/trending/index.html>`_
-   - per VPP build MRR throughput measurements against the trendline
-   with anomaly highlights, with associated CSIT test jobs.
+.. _vpp_known_issues:
 
 Known Issues
 ------------
 
 List of known issues in |csit-release| for VPP performance tests:
 
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| # | Issue                                           | Jira ID    | Description                                                     |
-+===+=================================================+============+=================================================================+
-| 1 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570   | DPDK reporting rx-errors, indicating L1 issue. Suspected issue  |
-|   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |
-|   |                                                 |            | outside of LF testbeds.                                         |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 2 | Lower than expected NDR throughput of DPDK      | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |
-|   | testpmd and VPP L2 path NDR throughput with     |            | PDR throughput on XL710 and X710 NICs.                          |
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            |                                                                 |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 3 | Tagged Ethernet dot1q and dot1ad L2 path        | CSIT-1066  | Tagged Ethernet dot1q and dot1ad L2 path throughput regression: |
-|   | throughput regression.                          |            | NDR -2%..-5%, PDR -2%..-6%, MRR. Affects l2xc and l2bd          |
-|   |                                                 |            | performance tests.                                              |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 4 | IPSec (software, no QAT HW) throughput          | CSIT-1064  | IPSec throughput regression: NDR -3%..-8%, PDR -2%..-8%, MRR    |
-|   | regression.                                     |            | -3%..-7%. Affects IPSec SW tests, QAT HW tests not affected.    |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
-| 5 | High failure rate of creating working container | CSIT-1065  | About 20% of orchestrated container topology tests failing data |
-|   | topologies with K8s/Ligato orchestration.       |            | plane verification indicating configuration issue. Suspected    |
-|   |                                                 |            | issue with Ligato vpp-agent.                                    |
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| #  | 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  | `CSIT-1503                              | [`TRex-519 <https://trex-tgn.cisco.com/youtrack/issue/trex-519>`_] XL710/XXV710 with FW 6.0.1 will have  |
+|    | <https://jira.fd.io/browse/CSIT-1503>`_ | Rx drop rate of 27MPPS.                                                                                  |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 3  | `CSIT-1501                              | Sporadic crypto backend fails loading `VPP-1670 <https://jira.fd.io/browse/VPP-1670>`_                   |
+|    | <https://jira.fd.io/browse/CSIT-1501>`_ |                                                                                                          |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 4  | `CSIT-1427                              | Sporadic HW aes-128-cbc-sha1 tunnel-interface tests are failing.                                         |
+|    | <https://jira.fd.io/browse/CSIT-1427>`_ | `VPP-1671 <https://jira.fd.io/browse/VPP-1671>`_                                                         |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 5  | `CSIT-1498                              | Memif tests are sporadically failing on initialization of memif connection.                              |
+|    | <https://jira.fd.io/browse/CSIT-1498>`_ |                                                                                                          |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 6  | `CSIT-1499                              | AVF tests are sporadically failing on initialization of AVF interface.                                   |
+|    | <https://jira.fd.io/browse/CSIT-1499>`_ |                                                                                                          |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 7  | `VPP-1676                               | 9000B ip4 memif errors - ip4-input: ip4 length > l2 length.                                              |
+|    | <https://jira.fd.io/browse/VPP-1676>`_  | IP4 jumbo frames (9000B) are dropped in case of tests with memif.                                        |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+
+| 8  | `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).  |
++----+-----------------------------------------+----------------------------------------------------------------------------------------------------------+