report: updated rls notes for vpp performance section
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 74517c3..4e5280f 100644 (file)
-CSIT Release Notes\r
-==================\r
-\r
-Changes in CSIT |release|\r
--------------------------\r
-\r
-#. **Added VPP performance tests**\r
-\r
-   - **MRR tests** : New MRR tests measure the packet forwarding rate\r
-       under the maximum load offered by traffic generator over a set\r
-       trial duration, regardless of packet loss. Maximum load for\r
-       specified Ethernet frame size is set to the bi-directional link\r
-       rate. MRR tests are used for continuous performance trending and\r
-       for comparison between releases.\r
-\r
-   - **SRv6** : Initial SRv6 (Segment Routing IPv6) tests verifying\r
-       performance of IPv6 and SRH (Segment Routing Header)\r
-       encapsulation, decapsulation, lookups and rewrites based on\r
-       configured End and End.DX6 SRv6 egress functions.\r
-\r
-#. **Presentation and Analytics Layer (PAL)**\r
-\r
-     - Added continuous performance measuring, trending and anomaly\r
-       detection. Includes new PAL code and Jenkins jobs for Performance\r
-       Trending (PT) and Performance Analysis (PA) producing performance\r
-       trending dashboard and trendline graphs with summary and drill-\r
-       down views across all specified tests that can be reviewed and\r
-       inspected regularly by FD.io developers and users community.\r
-\r
-#. **Test Framework Optimizations**\r
-\r
-     - **Performance tests efficiency** : Qemu build/install\r
-     optimizations, warmup phase handling, vpp restart handling.\r
-     Resulted in improved stability and reduced total execution time by\r
-     30% for single pkt size e.g. 64B/78B.\r
-\r
-     - **General code housekeeping** : ongoing RF keywords\r
-     optimizations, removal of redundant RF keywords.\r
-\r
-Performance Changes\r
--------------------\r
-\r
-Relative performance changes in measured packet throughput in CSIT\r
-|release| are calculated against the results from CSIT |release-1|\r
-report. Listed mean and standard deviation values are computed based on\r
-a series of the same tests executed against respective VPP releases to\r
-verify test results repeatibility, with percentage change calculated for\r
-mean values. Note that the standard deviation is quite high for a small\r
-number of packet throughput tests, what indicates poor test results\r
-repeatability and makes the relative change of mean throughput value not\r
-fully representative for these tests. The root causes behind poor\r
-results repeatibility vary between the test cases.\r
-\r
-NDR Throughput Changes\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-NDR small packet throughput changes between releases are available in a CSV and\r
-pretty ASCII formats:\r
-\r
-  - `csv format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.csv>`_,\r
-  - `csv format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.csv>`_,\r
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-ndr-1t1c-full.txt>`_,\r
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-ndr-2t2c-full.txt>`_.\r
-\r
-PDR Throughput Changes\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-NDR small packet throughput changes between releases are available in a CSV and\r
-pretty ASCII formats:\r
-\r
-  - `csv format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.csv>`_,\r
-  - `csv format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.csv>`_,\r
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-pdr-1t1c-full.txt>`_,\r
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-pdr-2t2c-full.txt>`_.\r
-\r
-Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-18.01 release notes\r
-<https://docs.fd.io/vpp/18.01/release_notes_1801.html>`_.\r
-\r
-MRR Throughput Changes\r
-~~~~~~~~~~~~~~~~~~~~~~\r
-\r
-MRR changes between releases are available in a CSV and\r
-pretty ASCII formats:\r
-\r
-  - `csv format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.csv>`_,\r
-  - `csv format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.csv>`_,\r
-  - `csv format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.csv>`_,\r
-  - `pretty ASCII format for 1t1c <../_static/vpp/performance-changes-mrr-1t1c-full.txt>`_,\r
-  - `pretty ASCII format for 2t2c <../_static/vpp/performance-changes-mrr-2t2c-full.txt>`_,\r
-  - `pretty ASCII format for 4t4c <../_static/vpp/performance-changes-mrr-4t4c-full.txt>`_.\r
-\r
-Known Issues\r
-------------\r
-\r
-<to be updated before rls1804 release>\r
-\r
-Here is the list of known issues in CSIT |release| for VPP performance tests:\r
-\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| # | Issue                                           | Jira ID    | Description                                                     |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 1 | Vic1385 and Vic1227 low performance.            | VPP-664    | Low NDR performance.                                            |\r
-|   |                                                 |            |                                                                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 2 | Sporadic (1 in 200) NDR discovery test failures | CSIT-570   | DPDK reporting rx-errors, indicating L1 issue. Suspected issue  |\r
-|   | on x520.                                        |            | with HW combination of X710-X520 in LF testbeds. Not observed   |\r
-|   |                                                 |            | outside of LF testbeds.                                         |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 3 | Lower than expected NDR throughput with         | CSIT-571   | Suspected NIC firmware or DPDK driver issue affecting NDR and   |\r
-|   | xl710 and x710 NICs, compared to x520 NICs.     |            | PDR throughput. Applies to XL710 and X710 NICs.                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 4 | rls1801 plugin related performance regression   | CSIT-925   | With all plugins loaded NDR, PDR and MaxRates vary              |\r
-|   |                                                 |            | intermittently from 3% to 5% across multiple test executions.   |\r
-|   |                                                 |            | Requires plugin code bisecting.                                 |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 5 | rls1801 generic small performance regression    | CSIT-926   | Generic performance regression of discovered NDR, PDR and       |\r
-|   | ip4base, l2xcbase, l2bdbase                     |            | MaxRates of -3%..-1% vs. rls1710, affects ip4base, l2xcbase,    |\r
-|   |                                                 |            | l2bdbase test suites. Not detected by CSIT performance trending |\r
-|   |                                                 |            | scheme as it was masked out by another issue CSIT-925.          |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
-| 6 | rls1801 substantial NDR/PDR regression for      | CSIT-928   | NDR regression of -7%..-15%, PDR regression of -3%..-15%        |\r
-|   | IPSec tunnel scale with HW QAT crypto-dev       |            | compared to rls1710.                                            |\r
-+---+-------------------------------------------------+------------+-----------------------------------------------------------------+\r
+Release Notes
+=============
+
+Changes in |csit-release|
+-------------------------
+
+#. VPP PERFORMANCE TESTS
+
+   - 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.
+
+   - 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`.
+
+#. TEST FRAMEWORK
+
+   - **CSIT PAPI support**: Due to issues with PAPI performance, VAT is
+     still used in CSIT for all VPP scale tests. See known issues below.
+
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+     removal of redundant RF keywords and aligning of suite/test
+     setup/teardowns.
+
+#. PRESENTATION AND ANALYTICS LAYER
+
+   - **Graphs layout improvements**: Improved performance graphs layout
+     for better readibility and maintenance: test grouping, axis
+     labels, descriptions, other informative decoration.
+
+.. raw:: latex
+
+    \clearpage
+
+.. _vpp_known_issues:
+
+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-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>`_ |                                                                                                           |
++----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+