CSIT-1430 Update release notes
[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst
index 193f685..50dce62 100644 (file)
-CSIT Release Notes\r
-==================\r
-\r
-Changes in CSIT |release| - to be updated\r
--------------------------\r
-\r
-#. VPP performance test environment changes\r
-\r
-    - further VM and vhost-user test environment optimizations - Qemu virtio queue size increased from default value of 256 to 1024\r
-    - addition of HW cryptodev devices in all three LF FD.io physical testbeds\r
-\r
-#. Added tests (to be updated)\r
-\r
-    - NICs\r
-\r
-      - Intel x710 (L2 Bridge Domain switched-forwarding, vhost-user)\r
-      - Cisco VIC1385 (L2 Bridge Domain switched-forwarding)\r
-      - Cisco VIC1227 (L2 Bridge Domain switched-forwarding)\r
-\r
-    - vhost-user tests with VM\r
-\r
-      - L2 Bridge Domain switched-forwarding with Intel x710 NIC\r
-      - L2 Bridge Domain switched-forwarding with VxLAN and Intel x520 NIC\r
-      - L2 Bridge Domain switched-forwarding with Intel xl710 NIC\r
-\r
-    - Tests with VxLAN\r
-\r
-      - L2 Bridge Domain switched-forwarding with Intel x520 NIC\r
-      - L2 Bridge Domain switched-forwarding with vhost-user, VM and Intel x520\r
-        NIC\r
-\r
-Performance Improvements - to be updated\r
-------------------------\r
-\r
-Substantial improvements in measured packet throughput, with relative increase\r
-of double-digit percentage points, have been observed in a number of CSIT\r
-|release| tests listed below. Relative improvements are calculated against the\r
-test results in CSIT rls1701 report.\r
-\r
-NDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Non-Drop Rate Throughput discovery tests:\r
-\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+----------------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09  | VPP-17.01 | VPP-17.04 | 17.01 to 17.04 |\r
-|                   |                                                                 |   [Mpps]   |  [Mpps]   |   [Mpps]  |  Improvement   |\r
-+===================+=================================================================+============+===========+===========+================+\r
-| L2XC              | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-ndrdisc                      | 9.4        | 12.7      | 13.4      | 6%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2XC              | 10ge2p1xl710: 64B-1t1c-eth-l2xcbase-ndrdisc                     | 9.5        | 12.2      | 12.4      | 2%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2XC dot1ad       | 10ge2p1x520: 64B-1t1c-dot1ad-l2xcbase-ndrdisc                   | 7.4        | 8.8       | 9.3       | 6%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2XC dot1q        | 10ge2p1x520: 64B-1t1c-dot1q-l2xcbase-ndrdisc                    | 7.5        | 8.8       | 9.2       | 5%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2XC VxLAN        | 10ge2p1x520: 64B-1t1c-ethip4vxlan-l2xcbase-ndrdisc              | 5.4        | 6.5       | 6.8       | 5%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2XC-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-eth-2vhost-1vm-ndrdisc       | 0.5        | 2.8       | 3.2       | 14%            |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2BD              | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-ndrdisc                | 7.8        | 10.4      | 10.8      | 4%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| L2BD-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc | 0.4        | 2.7       | 3.4       | 26%            |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| IPv4              | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-ndrdisc                    | 8.7        | 9.7       | 10.6      | 9%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| IPv4 COP          | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-copwhtlistbase-ndrdisc     | 7.1        | 8.3       | 9.0       | 8%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| IPv4 iAcl         | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-iacldstbase-ndrdisc        | 6.9        | 7.6       | 8.3       | 9%             |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| IPv4 vhost        | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-eth-2vhost-1vm-ndrdisc     | 0.3        | 2.6       | 3.1       | 19%            |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-| IPv6              | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-ndrdisc                    | 3.0        | 7.3       | 8.5       | 16%            |\r
-+-------------------+-----------------------------------------------------------------+------------+-----------+-----------+----------------+\r
-\r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
-\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-------------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01 | VPP-17.04 | Relative    |\r
-|                   |                                                                 |   [Mpps]  |  [Mpps]   |   [Mpps]  | Improvement |\r
-+===================+=================================================================+===========+===========+===========+=============+\r
-| L2XC              | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-pdrdisc                      | 9.4       | 12.7      | 13.4      |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| L2XC dot1ad       | 10ge2p1x520: 64B-1t1c-dot1ad-l2xcbase-pdrdisc                   | 7.4       | 8.8       | 9.3       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| L2XC dot1q        | 10ge2p1x520: 64B-1t1c-dot1q-l2xcbase-pdrdisc                    | 7.5       | 8.8       | 9.5       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| L2XC VxLAN        | 10ge2p1x520: 64B-1t1c-ethip4vxlan-l2xcbase-pdrdisc              | 5.4       | 6.5       | 6.8       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| L2XC-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2xcbase-eth-2vhost-1vm-pdrdisc       | 2.6       | 3.2       | 3.2       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| L2BD              | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-pdrdisc                | 7.8       | 10.6      | 11.1      |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| L2BD-vhost-VM     | 10ge2p1x520: 64B-1t1c-eth-l2bdbasemaclrn-eth-2vhost-1vm-pdrdisc | 2.1       | 2.9       | 3.2       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4              | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-pdrdisc                    | 8.7       | 9.7       | 10.6      |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 COP          | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-copwhtlistbase-pdrdisc     | 7.1       | 8.3       | 9.2       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 vhost        | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-eth-2vhost-1vm-pdrdisc     | 2.0       | 2.7       | 3.2       |   %         |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-\r
-Measured improvements are in line with VPP code optimizations listed in\r
-`VPP-17.04 release notes\r
-<https://docs.fd.io/vpp/17.04/release_notes_1704.html>`_.\r
-\r
-Additionally, vhost-VM performance improvements are due to both VPP code\r
-optimizations as well as due to the FD.io CSIT Linux KVM test environment\r
-optimizations for vhost-VM tests - see section "2.1.7. Methodology: KVM VM\r
-vhost".\r
-\r
-\r
-Other Performance Changes - to be updated\r
--------------------------\r
-\r
-Other changes in measured packet throughput, with either minor relative\r
-increase or decrease, have been observed in a number of CSIT |release| tests\r
-listed below. Relative changes are calculated against the test results in CSIT\r
-rls1701 report.\r
-\r
-NDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Non-Drop Rate Throughput discovery tests:\r
-\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-------------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01 | VPP-17.04 | Relative    |\r
-|                   |                                                                 |   [Mpps]  |  [Mpps]   |   [Mpps]  | Change      |\r
-+===================+=================================================================+===========+===========+===========+=============+\r
-| IPv4 FIB 200k     | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale200k-ndrdisc               | 8.5       | 9.0       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 FIB 20k      | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale20k-ndrdisc                | 8.5       | 9.0       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 FIB 2M       | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale2m-ndrdisc                 | 8.5       | 7.8       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 Policer      | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-ipolicemarkbase-ndrdisc    | 6.9       | 7.4       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 LISP         | 10ge2p1x520: 64B-1t1c-ethip4lispip4-ip4base-ndrdisc             | 4.4       | 4.8       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 COP          | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-copwhtlistbase-ndrdisc     | 6.1       | 6.1       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 FIB 200k     | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale200k-ndrdisc               | 6.5       | 5.3       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 FIB 20k      | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale20k-ndrdisc                | 6.9       | 6.5       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 FIB 2M       | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale2m-ndrdisc                 | 5.3       | 4.2       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 iAcl         | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-iacldstbase-ndrdisc        | 6.5       | 6.1       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-\r
-PDR Throughput\r
-~~~~~~~~~~~~~~\r
-\r
-Partial Drop Rate thoughput discovery tests with packet Loss Tolerance of 0.5%:\r
-\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-------------------------+\r
-| VPP Functionality | Test Name                                                       | VPP-16.09 | VPP-17.01 | VPP-17.04 | Relative    |\r
-|                   |                                                                 |   [Mpps]  |  [Mpps]   |   [Mpps]  | Change      |\r
-+===================+=================================================================+===========+===========+===========+=============+\r
-| IPv4 FIB 200k     | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale200k-pdrdisc               | 8.5       | 9.0       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 FIB 20k      | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale20k-pdrdisc                | 8.5       | 9.0       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 FIB 2M       | 10ge2p1x520: 64B-1t1c-ethip4-ip4scale2m-pdrdisc                 | 8.3       | 8.1       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 iAcl         | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-iacldstbase-pdrdisc        | 7.1       | 7.6       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 Policer      | 10ge2p1x520: 64B-1t1c-ethip4-ip4base-ipolicemarkbase-pdrdisc    | 7.1       | 7.4       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv4 LISP         | 10ge2p1x520: 64B-1t1c-ethip4lispip4-ip4base-pdrdisc             | 4.6       | 4.8       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6              | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-pdrdisc                    | 7.7       | 7.3       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 COP          | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-copwhtlistbase-pdrdisc     | 6.1       | 6.1       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 FIB 200k     | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale200k-pdrdisc               | 6.9       | 5.3       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 FIB 20k      | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale20k-pdrdisc                | 6.9       | 6.5       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 FIB 2M       | 10ge2p1x520: 78B-1t1c-ethip6-ip6scale2m-pdrdisc                 | 5.3       | 4.2       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-| IPv6 iAcl         | 10ge2p1x520: 78B-1t1c-ethip6-ip6base-iacldstbase-pdrdisc        | 6.5       | 6.1       |           |  %          |\r
-+-------------------+-----------------------------------------------------------------+-----------+-----------+-----------+-------------+\r
-\r
-Known Issues - to be updated\r
-------------\r
-\r
-Here is the list of known issues in CSIT |release| for VPP performance tests: (to be updated)\r
-\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| # | Issue                                           | Description                                                     |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 1 | Sporadic IPv4 routed-forwarding NDR discovery   | Suspected issue with DPDK IPv4 checksum calculation.            |\r
-|   | test failures for 1518B frame size              | Observed frequency: sporadic, ca. 20% to 30% of test runs.      |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 3 | Vic1385 and Vic1227 performance                 | Low performance of NDR results. Big difference between NDR and  |\r
-|   |                                                 | PDR.                                  .                         |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 4 | Sporadic NDR discovery test failures on x520    | Suspected issue with HW settings (BIOS, FW) in LF               |\r
-|   |                                                 | infrastructure. Issue can't be replicated outside LF.           |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-| 5 | Non-repeatible zig-zagging NDR throughput       | Suspected NIC driver issue in multi-thread multi-core operation |\r
-|   | results for multi-thread multi-core tests       | affectin NDR throughput. Applies to XL710 and X710 NICs tested. |\r
-|   | - 2t2c, 4t4c - for some tested NICs.            |                                                                 |\r
-+---+-------------------------------------------------+-----------------------------------------------------------------+\r
-\r
+Release Notes
+=============
+
+Changes in |csit-release|
+-------------------------
+
+#. VPP PERFORMANCE TESTS
+
+   - **Service density 2n-skx tests**: Network Function Virtualization (NFV)
+     service density tests focus on measuring total per server throughput at
+     varied NFV service *packing* densities with vswitch providing host
+     dataplane. The goal is to compare and contrast performance of a shared
+     vswitch for different network topologies and virtualization technologies,
+     and their impact on vswitch performance and efficiency in a range of NFV
+     service configurations.
+
+   - **Experimental Soak Tests**: Added 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, months, years. See updated
+     :ref:`test_methodology` section for more details.
+
+#. TEST FRAMEWORK
+
+   - **Container code optimizations**: Optimized container library allows to
+     run containre_memif tests faster.
+
+   - **CSIT PAPI Support**: Continue converting existing VAT L1 keywords to
+     PAPI L1 KWs in CSIT using VPP Python bindings. Required for migrating away
+     from VAT.
+
+   - **General Code Housekeeping**: Ongoing RF keywords optimizations,
+     removal of redundant RF keywords.
+
+#. PRESENTATION AND ANALYTICS LAYER
+
+   - **Graphs Layout Improvements**: Improved performance graphs layout
+     for better readibility and maintenance: test grouping, axis
+     labels, descriptions, other informative decoration.
+
+#. MISCELLANEOUS
+
+   - **3n-dnv Tests (3rd Party)**: Published performance tests for 3n-
+     dnv (3-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.
+
+.. 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-1562                               | Link bonding (mode LACP, transmit policy l34) test are failing due to VPP crashing producing core dump.                         |
+|    | <https://jira.fd.io/browse/VPP-1562>`_  |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 3  | `CSIT-1427                              | Scale HW IPsec are failing due to issue with selecting ipsec backend in VPP.                                                    |
+|    | <https://jira.fd.io/browse/CSIT-1427>`_ |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 4  | `VPP-1563                               | AVF L2patch tests are failing for all packet size and core combination. Reason: null-node blackholed packets in show error.     |
+|    | <https://jira.fd.io/browse/VPP-1563>`_  |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 5  | `CSIT-1234                              | VPP IPSecHW/IPSecsW scale interface mode, low NDR and PDR 64B throughput in 3n-hsw testbeds, in CSIT-19.01 vs. CSIT-18.10.      |
+|    | <https://jira.fd.io/browse/CSIT-1234>`_ |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| 6  | `CSIT-1428                              | VM vhost tests with RXQ more than 2 are failing on 3n-skx. Suspecting RXQ configuration issues.                                 |
+|    | <https://jira.fd.io/browse/CSIT-1428>`_ |                                                                                                                                 |
++----+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+